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;
94 static void gss_destroy_ctx(struct gss_cl_ctx *);
95 static struct rpc_pipe_ops gss_upcall_ops;
97 static inline struct gss_cl_ctx *
98 gss_get_ctx(struct gss_cl_ctx *ctx)
100 atomic_inc(&ctx->count);
105 gss_put_ctx(struct gss_cl_ctx *ctx)
107 if (atomic_dec_and_test(&ctx->count))
108 gss_destroy_ctx(ctx);
112 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
114 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
115 struct gss_cl_ctx *old;
116 write_lock(&gss_ctx_lock);
117 old = gss_cred->gc_ctx;
118 gss_cred->gc_ctx = ctx;
119 cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
120 cred->cr_flags &= ~RPCAUTH_CRED_NEW;
121 write_unlock(&gss_ctx_lock);
127 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
129 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
132 read_lock(&gss_ctx_lock);
133 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
135 read_unlock(&gss_ctx_lock);
140 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
142 const void *q = (const void *)((const char *)p + len);
143 if (unlikely(q > end || q < p))
144 return ERR_PTR(-EFAULT);
149 static inline const void *
150 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
155 p = simple_get_bytes(p, end, &len, sizeof(len));
158 q = (const void *)((const char *)p + len);
159 if (unlikely(q > end || q < p))
160 return ERR_PTR(-EFAULT);
161 dest->data = kmemdup(p, len, GFP_KERNEL);
162 if (unlikely(dest->data == NULL))
163 return ERR_PTR(-ENOMEM);
168 static struct gss_cl_ctx *
169 gss_cred_get_ctx(struct rpc_cred *cred)
171 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
172 struct gss_cl_ctx *ctx = NULL;
174 read_lock(&gss_ctx_lock);
175 if (gss_cred->gc_ctx)
176 ctx = gss_get_ctx(gss_cred->gc_ctx);
177 read_unlock(&gss_ctx_lock);
181 static struct gss_cl_ctx *
182 gss_alloc_context(void)
184 struct gss_cl_ctx *ctx;
186 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
188 ctx->gc_proc = RPC_GSS_PROC_DATA;
189 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
190 spin_lock_init(&ctx->gc_seq_lock);
191 atomic_set(&ctx->count,1);
196 #define GSSD_MIN_TIMEOUT (60 * 60)
198 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
202 unsigned int timeout;
206 /* First unsigned int gives the lifetime (in seconds) of the cred */
207 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
211 timeout = GSSD_MIN_TIMEOUT;
212 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
213 /* Sequence number window. Determines the maximum number of simultaneous requests */
214 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
217 ctx->gc_win = window_size;
218 /* gssd signals an error by passing ctx->gc_win = 0: */
219 if (ctx->gc_win == 0) {
220 /* in which case, p points to an error code which we ignore */
221 p = ERR_PTR(-EACCES);
224 /* copy the opaque wire context */
225 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
228 /* import the opaque security context */
229 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
232 q = (const void *)((const char *)p + seclen);
233 if (unlikely(q > end || q < p)) {
234 p = ERR_PTR(-EFAULT);
237 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
244 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
249 struct gss_upcall_msg {
252 struct rpc_pipe_msg msg;
253 struct list_head list;
254 struct gss_auth *auth;
255 struct rpc_wait_queue rpc_waitqueue;
256 wait_queue_head_t waitqueue;
257 struct gss_cl_ctx *ctx;
261 gss_release_msg(struct gss_upcall_msg *gss_msg)
263 if (!atomic_dec_and_test(&gss_msg->count))
265 BUG_ON(!list_empty(&gss_msg->list));
266 if (gss_msg->ctx != NULL)
267 gss_put_ctx(gss_msg->ctx);
271 static struct gss_upcall_msg *
272 __gss_find_upcall(struct gss_auth *gss_auth, uid_t uid)
274 struct gss_upcall_msg *pos;
275 list_for_each_entry(pos, &gss_auth->upcalls, list) {
278 atomic_inc(&pos->count);
279 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
282 dprintk("RPC: gss_find_upcall found nothing\n");
286 /* Try to add a upcall to the pipefs queue.
287 * If an upcall owned by our uid already exists, then we return a reference
288 * to that upcall instead of adding the new upcall.
290 static inline struct gss_upcall_msg *
291 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
293 struct gss_upcall_msg *old;
295 spin_lock(&gss_auth->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(&gss_auth->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;
322 spin_lock(&gss_auth->lock);
323 __gss_unhash_msg(gss_msg);
324 spin_unlock(&gss_auth->lock);
328 gss_upcall_callback(struct rpc_task *task)
330 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
331 struct gss_cred, gc_base);
332 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
334 BUG_ON(gss_msg == NULL);
336 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
338 task->tk_status = gss_msg->msg.errno;
339 spin_lock(&gss_msg->auth->lock);
340 gss_cred->gc_upcall = NULL;
341 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
342 spin_unlock(&gss_msg->auth->lock);
343 gss_release_msg(gss_msg);
346 static inline struct gss_upcall_msg *
347 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
349 struct gss_upcall_msg *gss_msg;
351 gss_msg = kzalloc(sizeof(*gss_msg), GFP_KERNEL);
352 if (gss_msg != NULL) {
353 INIT_LIST_HEAD(&gss_msg->list);
354 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
355 init_waitqueue_head(&gss_msg->waitqueue);
356 atomic_set(&gss_msg->count, 1);
357 gss_msg->msg.data = &gss_msg->uid;
358 gss_msg->msg.len = sizeof(gss_msg->uid);
360 gss_msg->auth = gss_auth;
365 static struct gss_upcall_msg *
366 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
368 struct gss_upcall_msg *gss_new, *gss_msg;
370 gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
372 return ERR_PTR(-ENOMEM);
373 gss_msg = gss_add_msg(gss_auth, gss_new);
374 if (gss_msg == gss_new) {
375 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
377 gss_unhash_msg(gss_new);
378 gss_msg = ERR_PTR(res);
381 gss_release_msg(gss_new);
386 gss_refresh_upcall(struct rpc_task *task)
388 struct rpc_cred *cred = task->tk_msg.rpc_cred;
389 struct gss_auth *gss_auth = container_of(cred->cr_auth,
390 struct gss_auth, rpc_auth);
391 struct gss_cred *gss_cred = container_of(cred,
392 struct gss_cred, gc_base);
393 struct gss_upcall_msg *gss_msg;
396 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task->tk_pid,
398 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
399 if (IS_ERR(gss_msg)) {
400 err = PTR_ERR(gss_msg);
403 spin_lock(&gss_auth->lock);
404 if (gss_cred->gc_upcall != NULL)
405 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
406 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
407 task->tk_timeout = 0;
408 gss_cred->gc_upcall = gss_msg;
409 /* gss_upcall_callback will release the reference to gss_upcall_msg */
410 atomic_inc(&gss_msg->count);
411 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
413 err = gss_msg->msg.errno;
414 spin_unlock(&gss_auth->lock);
415 gss_release_msg(gss_msg);
417 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
418 task->tk_pid, cred->cr_uid, err);
423 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
425 struct rpc_cred *cred = &gss_cred->gc_base;
426 struct gss_upcall_msg *gss_msg;
430 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
431 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
432 if (IS_ERR(gss_msg)) {
433 err = PTR_ERR(gss_msg);
437 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
438 spin_lock(&gss_auth->lock);
439 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
440 spin_unlock(&gss_auth->lock);
443 spin_unlock(&gss_auth->lock);
451 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
453 err = gss_msg->msg.errno;
455 finish_wait(&gss_msg->waitqueue, &wait);
456 gss_release_msg(gss_msg);
458 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
464 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
465 char __user *dst, size_t buflen)
467 char *data = (char *)msg->data + msg->copied;
468 ssize_t mlen = msg->len;
473 left = copy_to_user(dst, data, mlen);
484 #define MSG_BUF_MAXSIZE 1024
487 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
491 struct rpc_clnt *clnt;
492 struct gss_auth *gss_auth;
493 struct rpc_cred *cred;
494 struct gss_upcall_msg *gss_msg;
495 struct gss_cl_ctx *ctx;
499 if (mlen > MSG_BUF_MAXSIZE)
502 buf = kmalloc(mlen, GFP_KERNEL);
506 clnt = RPC_I(filp->f_path.dentry->d_inode)->private;
508 if (copy_from_user(buf, src, mlen))
511 end = (const void *)((char *)buf + mlen);
512 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
519 ctx = gss_alloc_context();
523 gss_auth = container_of(clnt->cl_auth, struct gss_auth, rpc_auth);
524 p = gss_fill_context(p, end, ctx, gss_auth->mech);
530 spin_lock(&gss_auth->lock);
531 gss_msg = __gss_find_upcall(gss_auth, uid);
533 if (err == 0 && gss_msg->ctx == NULL)
534 gss_msg->ctx = gss_get_ctx(ctx);
535 gss_msg->msg.errno = err;
536 __gss_unhash_msg(gss_msg);
537 spin_unlock(&gss_auth->lock);
538 gss_release_msg(gss_msg);
540 struct auth_cred acred = { .uid = uid };
541 spin_unlock(&gss_auth->lock);
542 cred = rpcauth_lookup_credcache(clnt->cl_auth, &acred, RPCAUTH_LOOKUP_NEW);
547 gss_cred_set_ctx(cred, gss_get_ctx(ctx));
551 dprintk("RPC: gss_pipe_downcall returning length %Zu\n", mlen);
558 dprintk("RPC: gss_pipe_downcall returning %d\n", err);
563 gss_pipe_release(struct inode *inode)
565 struct rpc_inode *rpci = RPC_I(inode);
566 struct rpc_clnt *clnt;
567 struct rpc_auth *auth;
568 struct gss_auth *gss_auth;
570 clnt = rpci->private;
571 auth = clnt->cl_auth;
572 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
573 spin_lock(&gss_auth->lock);
574 while (!list_empty(&gss_auth->upcalls)) {
575 struct gss_upcall_msg *gss_msg;
577 gss_msg = list_entry(gss_auth->upcalls.next,
578 struct gss_upcall_msg, list);
579 gss_msg->msg.errno = -EPIPE;
580 atomic_inc(&gss_msg->count);
581 __gss_unhash_msg(gss_msg);
582 spin_unlock(&gss_auth->lock);
583 gss_release_msg(gss_msg);
584 spin_lock(&gss_auth->lock);
586 spin_unlock(&gss_auth->lock);
590 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
592 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
593 static unsigned long ratelimit;
595 if (msg->errno < 0) {
596 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
598 atomic_inc(&gss_msg->count);
599 gss_unhash_msg(gss_msg);
600 if (msg->errno == -ETIMEDOUT) {
601 unsigned long now = jiffies;
602 if (time_after(now, ratelimit)) {
603 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
604 "Please check user daemon is running!\n");
605 ratelimit = now + 15*HZ;
608 gss_release_msg(gss_msg);
613 * NOTE: we have the opportunity to use different
614 * parameters based on the input flavor (which must be a pseudoflavor)
616 static struct rpc_auth *
617 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
619 struct gss_auth *gss_auth;
620 struct rpc_auth * auth;
621 int err = -ENOMEM; /* XXX? */
623 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
625 if (!try_module_get(THIS_MODULE))
627 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
629 gss_auth->client = clnt;
631 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
632 if (!gss_auth->mech) {
633 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
634 __FUNCTION__, flavor);
637 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
638 if (gss_auth->service == 0)
640 INIT_LIST_HEAD(&gss_auth->upcalls);
641 spin_lock_init(&gss_auth->lock);
642 auth = &gss_auth->rpc_auth;
643 auth->au_cslack = GSS_CRED_SLACK >> 2;
644 auth->au_rslack = GSS_VERF_SLACK >> 2;
645 auth->au_ops = &authgss_ops;
646 auth->au_flavor = flavor;
647 atomic_set(&auth->au_count, 1);
649 err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
653 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
654 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
655 if (IS_ERR(gss_auth->dentry)) {
656 err = PTR_ERR(gss_auth->dentry);
662 gss_mech_put(gss_auth->mech);
666 module_put(THIS_MODULE);
671 gss_destroy(struct rpc_auth *auth)
673 struct gss_auth *gss_auth;
675 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
676 auth, auth->au_flavor);
678 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
679 rpc_unlink(gss_auth->dentry);
680 gss_auth->dentry = NULL;
681 gss_mech_put(gss_auth->mech);
683 rpcauth_free_credcache(auth);
685 module_put(THIS_MODULE);
688 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
689 * to create a new cred or context, so they check that things have been
690 * allocated before freeing them. */
692 gss_destroy_ctx(struct gss_cl_ctx *ctx)
694 dprintk("RPC: gss_destroy_ctx\n");
697 gss_delete_sec_context(&ctx->gc_gss_ctx);
699 kfree(ctx->gc_wire_ctx.data);
704 gss_destroy_cred(struct rpc_cred *rc)
706 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
708 dprintk("RPC: gss_destroy_cred \n");
711 gss_put_ctx(cred->gc_ctx);
716 * Lookup RPCSEC_GSS cred for the current process
718 static struct rpc_cred *
719 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
721 return rpcauth_lookup_credcache(auth, acred, flags);
724 static struct rpc_cred *
725 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
727 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
728 struct gss_cred *cred = NULL;
731 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
732 acred->uid, auth->au_flavor);
734 if (!(cred = kzalloc(sizeof(*cred), GFP_KERNEL)))
737 atomic_set(&cred->gc_count, 1);
738 cred->gc_uid = acred->uid;
740 * Note: in order to force a call to call_refresh(), we deliberately
741 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
744 cred->gc_base.cr_auth = auth;
745 cred->gc_base.cr_ops = &gss_credops;
746 cred->gc_base.cr_flags = RPCAUTH_CRED_NEW;
747 cred->gc_service = gss_auth->service;
748 return &cred->gc_base;
751 dprintk("RPC: gss_create_cred failed with error %d\n", err);
756 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
758 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
759 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
763 err = gss_create_upcall(gss_auth, gss_cred);
764 } while (err == -EAGAIN);
769 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
771 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
774 * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
775 * we don't really care if the credential has expired or not,
776 * since the caller should be prepared to reinitialise it.
778 if ((flags & RPCAUTH_LOOKUP_NEW) && (rc->cr_flags & RPCAUTH_CRED_NEW))
780 /* Don't match with creds that have expired. */
781 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
784 return (rc->cr_uid == acred->uid);
788 * Marshal credentials.
789 * Maybe we should keep a cached credential for performance reasons.
792 gss_marshal(struct rpc_task *task, __be32 *p)
794 struct rpc_cred *cred = task->tk_msg.rpc_cred;
795 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
797 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
799 struct rpc_rqst *req = task->tk_rqstp;
801 struct xdr_netobj mic;
803 struct xdr_buf verf_buf;
805 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
807 *p++ = htonl(RPC_AUTH_GSS);
810 spin_lock(&ctx->gc_seq_lock);
811 req->rq_seqno = ctx->gc_seq++;
812 spin_unlock(&ctx->gc_seq_lock);
814 *p++ = htonl((u32) RPC_GSS_VERSION);
815 *p++ = htonl((u32) ctx->gc_proc);
816 *p++ = htonl((u32) req->rq_seqno);
817 *p++ = htonl((u32) gss_cred->gc_service);
818 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
819 *cred_len = htonl((p - (cred_len + 1)) << 2);
821 /* We compute the checksum for the verifier over the xdr-encoded bytes
822 * starting with the xid and ending at the end of the credential: */
823 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
824 req->rq_snd_buf.head[0].iov_base);
825 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
826 xdr_buf_from_iov(&iov, &verf_buf);
828 /* set verifier flavor*/
829 *p++ = htonl(RPC_AUTH_GSS);
831 mic.data = (u8 *)(p + 1);
832 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
833 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
834 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
835 } else if (maj_stat != 0) {
836 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
839 p = xdr_encode_opaque(p, NULL, mic.len);
848 * Refresh credentials. XXX - finish
851 gss_refresh(struct rpc_task *task)
854 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
855 return gss_refresh_upcall(task);
860 gss_validate(struct rpc_task *task, __be32 *p)
862 struct rpc_cred *cred = task->tk_msg.rpc_cred;
863 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
866 struct xdr_buf verf_buf;
867 struct xdr_netobj mic;
871 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
874 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
876 if (flav != RPC_AUTH_GSS)
878 seq = htonl(task->tk_rqstp->rq_seqno);
880 iov.iov_len = sizeof(seq);
881 xdr_buf_from_iov(&iov, &verf_buf);
885 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
886 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
887 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
890 /* We leave it to unwrap to calculate au_rslack. For now we just
891 * calculate the length of the verifier: */
892 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
894 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
896 return p + XDR_QUADLEN(len);
899 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
904 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
905 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
907 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
908 struct xdr_buf integ_buf;
909 __be32 *integ_len = NULL;
910 struct xdr_netobj mic;
918 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
919 *p++ = htonl(rqstp->rq_seqno);
921 status = encode(rqstp, p, obj);
925 if (xdr_buf_subsegment(snd_buf, &integ_buf,
926 offset, snd_buf->len - offset))
928 *integ_len = htonl(integ_buf.len);
930 /* guess whether we're in the head or the tail: */
931 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
935 p = iov->iov_base + iov->iov_len;
936 mic.data = (u8 *)(p + 1);
938 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
939 status = -EIO; /* XXX? */
940 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
941 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
944 q = xdr_encode_opaque(p, NULL, mic.len);
946 offset = (u8 *)q - (u8 *)p;
947 iov->iov_len += offset;
948 snd_buf->len += offset;
953 priv_release_snd_buf(struct rpc_rqst *rqstp)
957 for (i=0; i < rqstp->rq_enc_pages_num; i++)
958 __free_page(rqstp->rq_enc_pages[i]);
959 kfree(rqstp->rq_enc_pages);
963 alloc_enc_pages(struct rpc_rqst *rqstp)
965 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
968 if (snd_buf->page_len == 0) {
969 rqstp->rq_enc_pages_num = 0;
973 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
974 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
975 rqstp->rq_enc_pages_num = last - first + 1 + 1;
977 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
979 if (!rqstp->rq_enc_pages)
981 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
982 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
983 if (rqstp->rq_enc_pages[i] == NULL)
986 rqstp->rq_release_snd_buf = priv_release_snd_buf;
989 for (i--; i >= 0; i--) {
990 __free_page(rqstp->rq_enc_pages[i]);
997 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
998 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1000 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1005 struct page **inpages;
1012 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1013 *p++ = htonl(rqstp->rq_seqno);
1015 status = encode(rqstp, p, obj);
1019 status = alloc_enc_pages(rqstp);
1022 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1023 inpages = snd_buf->pages + first;
1024 snd_buf->pages = rqstp->rq_enc_pages;
1025 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1026 /* Give the tail its own page, in case we need extra space in the
1027 * head when wrapping: */
1028 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1029 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1030 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1031 snd_buf->tail[0].iov_base = tmp;
1033 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1034 /* RPC_SLACK_SPACE should prevent this ever happening: */
1035 BUG_ON(snd_buf->len > snd_buf->buflen);
1037 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1038 * done anyway, so it's safe to put the request on the wire: */
1039 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1040 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1044 *opaque_len = htonl(snd_buf->len - offset);
1045 /* guess whether we're in the head or the tail: */
1046 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1047 iov = snd_buf->tail;
1049 iov = snd_buf->head;
1050 p = iov->iov_base + iov->iov_len;
1051 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1053 iov->iov_len += pad;
1054 snd_buf->len += pad;
1060 gss_wrap_req(struct rpc_task *task,
1061 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1063 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1064 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1066 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1069 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1070 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1071 /* The spec seems a little ambiguous here, but I think that not
1072 * wrapping context destruction requests makes the most sense.
1074 status = encode(rqstp, p, obj);
1077 switch (gss_cred->gc_service) {
1078 case RPC_GSS_SVC_NONE:
1079 status = encode(rqstp, p, obj);
1081 case RPC_GSS_SVC_INTEGRITY:
1082 status = gss_wrap_req_integ(cred, ctx, encode,
1085 case RPC_GSS_SVC_PRIVACY:
1086 status = gss_wrap_req_priv(cred, ctx, encode,
1092 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1097 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1098 struct rpc_rqst *rqstp, __be32 **p)
1100 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1101 struct xdr_buf integ_buf;
1102 struct xdr_netobj mic;
1103 u32 data_offset, mic_offset;
1108 integ_len = ntohl(*(*p)++);
1111 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1112 mic_offset = integ_len + data_offset;
1113 if (mic_offset > rcv_buf->len)
1115 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1118 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1119 mic_offset - data_offset))
1122 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1125 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1126 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1127 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1128 if (maj_stat != GSS_S_COMPLETE)
1134 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1135 struct rpc_rqst *rqstp, __be32 **p)
1137 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1143 opaque_len = ntohl(*(*p)++);
1144 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1145 if (offset + opaque_len > rcv_buf->len)
1147 /* remove padding: */
1148 rcv_buf->len = offset + opaque_len;
1150 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1151 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1152 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1153 if (maj_stat != GSS_S_COMPLETE)
1155 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1163 gss_unwrap_resp(struct rpc_task *task,
1164 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1166 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1167 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1169 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1171 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1172 int savedlen = head->iov_len;
1175 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1177 switch (gss_cred->gc_service) {
1178 case RPC_GSS_SVC_NONE:
1180 case RPC_GSS_SVC_INTEGRITY:
1181 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1185 case RPC_GSS_SVC_PRIVACY:
1186 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1191 /* take into account extra slack for integrity and privacy cases: */
1192 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
1193 + (savedlen - head->iov_len);
1195 status = decode(rqstp, p, obj);
1198 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1203 static struct rpc_authops authgss_ops = {
1204 .owner = THIS_MODULE,
1205 .au_flavor = RPC_AUTH_GSS,
1207 .au_name = "RPCSEC_GSS",
1209 .create = gss_create,
1210 .destroy = gss_destroy,
1211 .lookup_cred = gss_lookup_cred,
1212 .crcreate = gss_create_cred
1215 static struct rpc_credops gss_credops = {
1216 .cr_name = "AUTH_GSS",
1217 .crdestroy = gss_destroy_cred,
1218 .cr_init = gss_cred_init,
1219 .crmatch = gss_match,
1220 .crmarshal = gss_marshal,
1221 .crrefresh = gss_refresh,
1222 .crvalidate = gss_validate,
1223 .crwrap_req = gss_wrap_req,
1224 .crunwrap_resp = gss_unwrap_resp,
1227 static struct rpc_pipe_ops gss_upcall_ops = {
1228 .upcall = gss_pipe_upcall,
1229 .downcall = gss_pipe_downcall,
1230 .destroy_msg = gss_pipe_destroy_msg,
1231 .release_pipe = gss_pipe_release,
1235 * Initialize RPCSEC_GSS module
1237 static int __init init_rpcsec_gss(void)
1241 err = rpcauth_register(&authgss_ops);
1244 err = gss_svc_init();
1246 goto out_unregister;
1249 rpcauth_unregister(&authgss_ops);
1254 static void __exit exit_rpcsec_gss(void)
1257 rpcauth_unregister(&authgss_ops);
1260 MODULE_LICENSE("GPL");
1261 module_init(init_rpcsec_gss)
1262 module_exit(exit_rpcsec_gss)