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 rpc_clnt *client;
89 struct dentry *dentry;
92 static void gss_destroy_ctx(struct gss_cl_ctx *);
93 static struct rpc_pipe_ops gss_upcall_ops;
95 static inline struct gss_cl_ctx *
96 gss_get_ctx(struct gss_cl_ctx *ctx)
98 atomic_inc(&ctx->count);
103 gss_put_ctx(struct gss_cl_ctx *ctx)
105 if (atomic_dec_and_test(&ctx->count))
106 gss_destroy_ctx(ctx);
110 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
112 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
113 struct gss_cl_ctx *old;
114 write_lock(&gss_ctx_lock);
115 old = gss_cred->gc_ctx;
116 gss_cred->gc_ctx = ctx;
117 cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
118 cred->cr_flags &= ~RPCAUTH_CRED_NEW;
119 write_unlock(&gss_ctx_lock);
125 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
127 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
130 read_lock(&gss_ctx_lock);
131 if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
133 read_unlock(&gss_ctx_lock);
138 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
140 const void *q = (const void *)((const char *)p + len);
141 if (unlikely(q > end || q < p))
142 return ERR_PTR(-EFAULT);
147 static inline const void *
148 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
153 p = simple_get_bytes(p, end, &len, sizeof(len));
156 q = (const void *)((const char *)p + len);
157 if (unlikely(q > end || q < p))
158 return ERR_PTR(-EFAULT);
159 dest->data = kmemdup(p, len, GFP_KERNEL);
160 if (unlikely(dest->data == NULL))
161 return ERR_PTR(-ENOMEM);
166 static struct gss_cl_ctx *
167 gss_cred_get_ctx(struct rpc_cred *cred)
169 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
170 struct gss_cl_ctx *ctx = NULL;
172 read_lock(&gss_ctx_lock);
173 if (gss_cred->gc_ctx)
174 ctx = gss_get_ctx(gss_cred->gc_ctx);
175 read_unlock(&gss_ctx_lock);
179 static struct gss_cl_ctx *
180 gss_alloc_context(void)
182 struct gss_cl_ctx *ctx;
184 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
186 ctx->gc_proc = RPC_GSS_PROC_DATA;
187 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
188 spin_lock_init(&ctx->gc_seq_lock);
189 atomic_set(&ctx->count,1);
194 #define GSSD_MIN_TIMEOUT (60 * 60)
196 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
200 unsigned int timeout;
204 /* First unsigned int gives the lifetime (in seconds) of the cred */
205 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
209 timeout = GSSD_MIN_TIMEOUT;
210 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
211 /* Sequence number window. Determines the maximum number of simultaneous requests */
212 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
215 ctx->gc_win = window_size;
216 /* gssd signals an error by passing ctx->gc_win = 0: */
217 if (ctx->gc_win == 0) {
218 /* in which case, p points to an error code which we ignore */
219 p = ERR_PTR(-EACCES);
222 /* copy the opaque wire context */
223 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
226 /* import the opaque security context */
227 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
230 q = (const void *)((const char *)p + seclen);
231 if (unlikely(q > end || q < p)) {
232 p = ERR_PTR(-EFAULT);
235 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
242 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
247 struct gss_upcall_msg {
250 struct rpc_pipe_msg msg;
251 struct list_head list;
252 struct gss_auth *auth;
253 struct rpc_wait_queue rpc_waitqueue;
254 wait_queue_head_t waitqueue;
255 struct gss_cl_ctx *ctx;
259 gss_release_msg(struct gss_upcall_msg *gss_msg)
261 if (!atomic_dec_and_test(&gss_msg->count))
263 BUG_ON(!list_empty(&gss_msg->list));
264 if (gss_msg->ctx != NULL)
265 gss_put_ctx(gss_msg->ctx);
269 static struct gss_upcall_msg *
270 __gss_find_upcall(struct rpc_inode *rpci, uid_t uid)
272 struct gss_upcall_msg *pos;
273 list_for_each_entry(pos, &rpci->in_downcall, list) {
276 atomic_inc(&pos->count);
277 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
280 dprintk("RPC: gss_find_upcall found nothing\n");
284 /* Try to add a upcall to the pipefs queue.
285 * If an upcall owned by our uid already exists, then we return a reference
286 * to that upcall instead of adding the new upcall.
288 static inline struct gss_upcall_msg *
289 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
291 struct inode *inode = gss_auth->dentry->d_inode;
292 struct rpc_inode *rpci = RPC_I(inode);
293 struct gss_upcall_msg *old;
295 spin_lock(&inode->i_lock);
296 old = __gss_find_upcall(rpci, gss_msg->uid);
298 atomic_inc(&gss_msg->count);
299 list_add(&gss_msg->list, &rpci->in_downcall);
302 spin_unlock(&inode->i_lock);
307 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
309 list_del_init(&gss_msg->list);
310 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
311 wake_up_all(&gss_msg->waitqueue);
312 atomic_dec(&gss_msg->count);
316 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
318 struct gss_auth *gss_auth = gss_msg->auth;
319 struct inode *inode = gss_auth->dentry->d_inode;
321 if (list_empty(&gss_msg->list))
323 spin_lock(&inode->i_lock);
324 if (!list_empty(&gss_msg->list))
325 __gss_unhash_msg(gss_msg);
326 spin_unlock(&inode->i_lock);
330 gss_upcall_callback(struct rpc_task *task)
332 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
333 struct gss_cred, gc_base);
334 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
335 struct inode *inode = gss_msg->auth->dentry->d_inode;
338 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
340 task->tk_status = gss_msg->msg.errno;
341 spin_lock(&inode->i_lock);
342 gss_cred->gc_upcall = NULL;
343 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
344 spin_unlock(&inode->i_lock);
345 gss_release_msg(gss_msg);
348 static inline struct gss_upcall_msg *
349 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
351 struct gss_upcall_msg *gss_msg;
353 gss_msg = kzalloc(sizeof(*gss_msg), GFP_KERNEL);
354 if (gss_msg != NULL) {
355 INIT_LIST_HEAD(&gss_msg->list);
356 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
357 init_waitqueue_head(&gss_msg->waitqueue);
358 atomic_set(&gss_msg->count, 1);
359 gss_msg->msg.data = &gss_msg->uid;
360 gss_msg->msg.len = sizeof(gss_msg->uid);
362 gss_msg->auth = gss_auth;
367 static struct gss_upcall_msg *
368 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
370 struct gss_upcall_msg *gss_new, *gss_msg;
372 gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
374 return ERR_PTR(-ENOMEM);
375 gss_msg = gss_add_msg(gss_auth, gss_new);
376 if (gss_msg == gss_new) {
377 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
379 gss_unhash_msg(gss_new);
380 gss_msg = ERR_PTR(res);
383 gss_release_msg(gss_new);
388 gss_refresh_upcall(struct rpc_task *task)
390 struct rpc_cred *cred = task->tk_msg.rpc_cred;
391 struct gss_auth *gss_auth = container_of(cred->cr_auth,
392 struct gss_auth, rpc_auth);
393 struct gss_cred *gss_cred = container_of(cred,
394 struct gss_cred, gc_base);
395 struct gss_upcall_msg *gss_msg;
396 struct inode *inode = gss_auth->dentry->d_inode;
399 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task->tk_pid,
401 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
402 if (IS_ERR(gss_msg)) {
403 err = PTR_ERR(gss_msg);
406 spin_lock(&inode->i_lock);
407 if (gss_cred->gc_upcall != NULL)
408 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
409 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
410 task->tk_timeout = 0;
411 gss_cred->gc_upcall = gss_msg;
412 /* gss_upcall_callback will release the reference to gss_upcall_msg */
413 atomic_inc(&gss_msg->count);
414 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
416 err = gss_msg->msg.errno;
417 spin_unlock(&inode->i_lock);
418 gss_release_msg(gss_msg);
420 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
421 task->tk_pid, cred->cr_uid, err);
426 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
428 struct inode *inode = gss_auth->dentry->d_inode;
429 struct rpc_cred *cred = &gss_cred->gc_base;
430 struct gss_upcall_msg *gss_msg;
434 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
435 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
436 if (IS_ERR(gss_msg)) {
437 err = PTR_ERR(gss_msg);
441 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
442 spin_lock(&inode->i_lock);
443 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
444 spin_unlock(&inode->i_lock);
447 spin_unlock(&inode->i_lock);
455 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
457 err = gss_msg->msg.errno;
459 finish_wait(&gss_msg->waitqueue, &wait);
460 gss_release_msg(gss_msg);
462 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
468 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
469 char __user *dst, size_t buflen)
471 char *data = (char *)msg->data + msg->copied;
472 ssize_t mlen = msg->len;
477 left = copy_to_user(dst, data, mlen);
488 #define MSG_BUF_MAXSIZE 1024
491 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
495 struct rpc_clnt *clnt;
496 struct gss_upcall_msg *gss_msg;
497 struct inode *inode = filp->f_path.dentry->d_inode;
498 struct gss_cl_ctx *ctx;
500 ssize_t err = -EFBIG;
502 if (mlen > MSG_BUF_MAXSIZE)
505 buf = kmalloc(mlen, GFP_KERNEL);
509 clnt = RPC_I(inode)->private;
511 if (copy_from_user(buf, src, mlen))
514 end = (const void *)((char *)buf + mlen);
515 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
522 ctx = gss_alloc_context();
527 /* Find a matching upcall */
528 spin_lock(&inode->i_lock);
529 gss_msg = __gss_find_upcall(RPC_I(inode), uid);
530 if (gss_msg == NULL) {
531 spin_unlock(&inode->i_lock);
534 list_del_init(&gss_msg->list);
535 spin_unlock(&inode->i_lock);
537 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
540 gss_msg->msg.errno = (err == -EACCES) ? -EACCES : -EAGAIN;
541 goto err_release_msg;
543 gss_msg->ctx = gss_get_ctx(ctx);
547 spin_lock(&inode->i_lock);
548 __gss_unhash_msg(gss_msg);
549 spin_unlock(&inode->i_lock);
550 gss_release_msg(gss_msg);
556 dprintk("RPC: gss_pipe_downcall returning %Zd\n", err);
561 gss_pipe_release(struct inode *inode)
563 struct rpc_inode *rpci = RPC_I(inode);
564 struct gss_upcall_msg *gss_msg;
566 spin_lock(&inode->i_lock);
567 while (!list_empty(&rpci->in_downcall)) {
569 gss_msg = list_entry(rpci->in_downcall.next,
570 struct gss_upcall_msg, list);
571 gss_msg->msg.errno = -EPIPE;
572 atomic_inc(&gss_msg->count);
573 __gss_unhash_msg(gss_msg);
574 spin_unlock(&inode->i_lock);
575 gss_release_msg(gss_msg);
576 spin_lock(&inode->i_lock);
578 spin_unlock(&inode->i_lock);
582 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
584 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
585 static unsigned long ratelimit;
587 if (msg->errno < 0) {
588 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
590 atomic_inc(&gss_msg->count);
591 gss_unhash_msg(gss_msg);
592 if (msg->errno == -ETIMEDOUT) {
593 unsigned long now = jiffies;
594 if (time_after(now, ratelimit)) {
595 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
596 "Please check user daemon is running!\n");
597 ratelimit = now + 15*HZ;
600 gss_release_msg(gss_msg);
605 * NOTE: we have the opportunity to use different
606 * parameters based on the input flavor (which must be a pseudoflavor)
608 static struct rpc_auth *
609 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
611 struct gss_auth *gss_auth;
612 struct rpc_auth * auth;
613 int err = -ENOMEM; /* XXX? */
615 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
617 if (!try_module_get(THIS_MODULE))
619 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
621 gss_auth->client = clnt;
623 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
624 if (!gss_auth->mech) {
625 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
626 __FUNCTION__, flavor);
629 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
630 if (gss_auth->service == 0)
632 auth = &gss_auth->rpc_auth;
633 auth->au_cslack = GSS_CRED_SLACK >> 2;
634 auth->au_rslack = GSS_VERF_SLACK >> 2;
635 auth->au_ops = &authgss_ops;
636 auth->au_flavor = flavor;
637 atomic_set(&auth->au_count, 1);
639 err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
643 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
644 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
645 if (IS_ERR(gss_auth->dentry)) {
646 err = PTR_ERR(gss_auth->dentry);
652 gss_mech_put(gss_auth->mech);
656 module_put(THIS_MODULE);
661 gss_destroy(struct rpc_auth *auth)
663 struct gss_auth *gss_auth;
665 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
666 auth, auth->au_flavor);
668 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
669 rpc_unlink(gss_auth->dentry);
670 gss_auth->dentry = NULL;
671 gss_mech_put(gss_auth->mech);
673 rpcauth_free_credcache(auth);
675 module_put(THIS_MODULE);
678 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
679 * to create a new cred or context, so they check that things have been
680 * allocated before freeing them. */
682 gss_destroy_ctx(struct gss_cl_ctx *ctx)
684 dprintk("RPC: gss_destroy_ctx\n");
687 gss_delete_sec_context(&ctx->gc_gss_ctx);
689 kfree(ctx->gc_wire_ctx.data);
694 gss_destroy_cred(struct rpc_cred *rc)
696 struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
698 dprintk("RPC: gss_destroy_cred \n");
701 gss_put_ctx(cred->gc_ctx);
706 * Lookup RPCSEC_GSS cred for the current process
708 static struct rpc_cred *
709 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
711 return rpcauth_lookup_credcache(auth, acred, flags);
714 static struct rpc_cred *
715 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
717 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
718 struct gss_cred *cred = NULL;
721 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
722 acred->uid, auth->au_flavor);
724 if (!(cred = kzalloc(sizeof(*cred), GFP_KERNEL)))
727 atomic_set(&cred->gc_count, 1);
728 cred->gc_uid = acred->uid;
730 * Note: in order to force a call to call_refresh(), we deliberately
731 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
734 cred->gc_base.cr_auth = auth;
735 cred->gc_base.cr_ops = &gss_credops;
736 cred->gc_base.cr_flags = RPCAUTH_CRED_NEW;
737 cred->gc_service = gss_auth->service;
738 return &cred->gc_base;
741 dprintk("RPC: gss_create_cred failed with error %d\n", err);
746 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
748 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
749 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
753 err = gss_create_upcall(gss_auth, gss_cred);
754 } while (err == -EAGAIN);
759 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
761 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
764 * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
765 * we don't really care if the credential has expired or not,
766 * since the caller should be prepared to reinitialise it.
768 if ((flags & RPCAUTH_LOOKUP_NEW) && (rc->cr_flags & RPCAUTH_CRED_NEW))
770 /* Don't match with creds that have expired. */
771 if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
774 return (rc->cr_uid == acred->uid);
778 * Marshal credentials.
779 * Maybe we should keep a cached credential for performance reasons.
782 gss_marshal(struct rpc_task *task, __be32 *p)
784 struct rpc_cred *cred = task->tk_msg.rpc_cred;
785 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
787 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
789 struct rpc_rqst *req = task->tk_rqstp;
791 struct xdr_netobj mic;
793 struct xdr_buf verf_buf;
795 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
797 *p++ = htonl(RPC_AUTH_GSS);
800 spin_lock(&ctx->gc_seq_lock);
801 req->rq_seqno = ctx->gc_seq++;
802 spin_unlock(&ctx->gc_seq_lock);
804 *p++ = htonl((u32) RPC_GSS_VERSION);
805 *p++ = htonl((u32) ctx->gc_proc);
806 *p++ = htonl((u32) req->rq_seqno);
807 *p++ = htonl((u32) gss_cred->gc_service);
808 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
809 *cred_len = htonl((p - (cred_len + 1)) << 2);
811 /* We compute the checksum for the verifier over the xdr-encoded bytes
812 * starting with the xid and ending at the end of the credential: */
813 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
814 req->rq_snd_buf.head[0].iov_base);
815 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
816 xdr_buf_from_iov(&iov, &verf_buf);
818 /* set verifier flavor*/
819 *p++ = htonl(RPC_AUTH_GSS);
821 mic.data = (u8 *)(p + 1);
822 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
823 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
824 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
825 } else if (maj_stat != 0) {
826 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
829 p = xdr_encode_opaque(p, NULL, mic.len);
838 * Refresh credentials. XXX - finish
841 gss_refresh(struct rpc_task *task)
844 if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
845 return gss_refresh_upcall(task);
850 gss_validate(struct rpc_task *task, __be32 *p)
852 struct rpc_cred *cred = task->tk_msg.rpc_cred;
853 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
856 struct xdr_buf verf_buf;
857 struct xdr_netobj mic;
861 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
864 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
866 if (flav != RPC_AUTH_GSS)
868 seq = htonl(task->tk_rqstp->rq_seqno);
870 iov.iov_len = sizeof(seq);
871 xdr_buf_from_iov(&iov, &verf_buf);
875 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
876 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
877 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
880 /* We leave it to unwrap to calculate au_rslack. For now we just
881 * calculate the length of the verifier: */
882 task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
884 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
886 return p + XDR_QUADLEN(len);
889 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
894 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
895 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
897 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
898 struct xdr_buf integ_buf;
899 __be32 *integ_len = NULL;
900 struct xdr_netobj mic;
908 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
909 *p++ = htonl(rqstp->rq_seqno);
911 status = encode(rqstp, p, obj);
915 if (xdr_buf_subsegment(snd_buf, &integ_buf,
916 offset, snd_buf->len - offset))
918 *integ_len = htonl(integ_buf.len);
920 /* guess whether we're in the head or the tail: */
921 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
925 p = iov->iov_base + iov->iov_len;
926 mic.data = (u8 *)(p + 1);
928 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
929 status = -EIO; /* XXX? */
930 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
931 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
934 q = xdr_encode_opaque(p, NULL, mic.len);
936 offset = (u8 *)q - (u8 *)p;
937 iov->iov_len += offset;
938 snd_buf->len += offset;
943 priv_release_snd_buf(struct rpc_rqst *rqstp)
947 for (i=0; i < rqstp->rq_enc_pages_num; i++)
948 __free_page(rqstp->rq_enc_pages[i]);
949 kfree(rqstp->rq_enc_pages);
953 alloc_enc_pages(struct rpc_rqst *rqstp)
955 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
958 if (snd_buf->page_len == 0) {
959 rqstp->rq_enc_pages_num = 0;
963 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
964 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
965 rqstp->rq_enc_pages_num = last - first + 1 + 1;
967 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
969 if (!rqstp->rq_enc_pages)
971 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
972 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
973 if (rqstp->rq_enc_pages[i] == NULL)
976 rqstp->rq_release_snd_buf = priv_release_snd_buf;
979 for (i--; i >= 0; i--) {
980 __free_page(rqstp->rq_enc_pages[i]);
987 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
988 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
990 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
995 struct page **inpages;
1002 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1003 *p++ = htonl(rqstp->rq_seqno);
1005 status = encode(rqstp, p, obj);
1009 status = alloc_enc_pages(rqstp);
1012 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1013 inpages = snd_buf->pages + first;
1014 snd_buf->pages = rqstp->rq_enc_pages;
1015 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1016 /* Give the tail its own page, in case we need extra space in the
1017 * head when wrapping: */
1018 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1019 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1020 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1021 snd_buf->tail[0].iov_base = tmp;
1023 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1024 /* RPC_SLACK_SPACE should prevent this ever happening: */
1025 BUG_ON(snd_buf->len > snd_buf->buflen);
1027 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1028 * done anyway, so it's safe to put the request on the wire: */
1029 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1030 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1034 *opaque_len = htonl(snd_buf->len - offset);
1035 /* guess whether we're in the head or the tail: */
1036 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1037 iov = snd_buf->tail;
1039 iov = snd_buf->head;
1040 p = iov->iov_base + iov->iov_len;
1041 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1043 iov->iov_len += pad;
1044 snd_buf->len += pad;
1050 gss_wrap_req(struct rpc_task *task,
1051 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1053 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1054 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1056 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1059 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1060 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1061 /* The spec seems a little ambiguous here, but I think that not
1062 * wrapping context destruction requests makes the most sense.
1064 status = encode(rqstp, p, obj);
1067 switch (gss_cred->gc_service) {
1068 case RPC_GSS_SVC_NONE:
1069 status = encode(rqstp, p, obj);
1071 case RPC_GSS_SVC_INTEGRITY:
1072 status = gss_wrap_req_integ(cred, ctx, encode,
1075 case RPC_GSS_SVC_PRIVACY:
1076 status = gss_wrap_req_priv(cred, ctx, encode,
1082 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1087 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1088 struct rpc_rqst *rqstp, __be32 **p)
1090 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1091 struct xdr_buf integ_buf;
1092 struct xdr_netobj mic;
1093 u32 data_offset, mic_offset;
1098 integ_len = ntohl(*(*p)++);
1101 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1102 mic_offset = integ_len + data_offset;
1103 if (mic_offset > rcv_buf->len)
1105 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1108 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1109 mic_offset - data_offset))
1112 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1115 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1116 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1117 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1118 if (maj_stat != GSS_S_COMPLETE)
1124 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1125 struct rpc_rqst *rqstp, __be32 **p)
1127 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1133 opaque_len = ntohl(*(*p)++);
1134 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1135 if (offset + opaque_len > rcv_buf->len)
1137 /* remove padding: */
1138 rcv_buf->len = offset + opaque_len;
1140 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1141 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1142 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
1143 if (maj_stat != GSS_S_COMPLETE)
1145 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1153 gss_unwrap_resp(struct rpc_task *task,
1154 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1156 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1157 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1159 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1161 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1162 int savedlen = head->iov_len;
1165 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1167 switch (gss_cred->gc_service) {
1168 case RPC_GSS_SVC_NONE:
1170 case RPC_GSS_SVC_INTEGRITY:
1171 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1175 case RPC_GSS_SVC_PRIVACY:
1176 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1181 /* take into account extra slack for integrity and privacy cases: */
1182 task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
1183 + (savedlen - head->iov_len);
1185 status = decode(rqstp, p, obj);
1188 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1193 static struct rpc_authops authgss_ops = {
1194 .owner = THIS_MODULE,
1195 .au_flavor = RPC_AUTH_GSS,
1197 .au_name = "RPCSEC_GSS",
1199 .create = gss_create,
1200 .destroy = gss_destroy,
1201 .lookup_cred = gss_lookup_cred,
1202 .crcreate = gss_create_cred
1205 static struct rpc_credops gss_credops = {
1206 .cr_name = "AUTH_GSS",
1207 .crdestroy = gss_destroy_cred,
1208 .cr_init = gss_cred_init,
1209 .crmatch = gss_match,
1210 .crmarshal = gss_marshal,
1211 .crrefresh = gss_refresh,
1212 .crvalidate = gss_validate,
1213 .crwrap_req = gss_wrap_req,
1214 .crunwrap_resp = gss_unwrap_resp,
1217 static struct rpc_pipe_ops gss_upcall_ops = {
1218 .upcall = gss_pipe_upcall,
1219 .downcall = gss_pipe_downcall,
1220 .destroy_msg = gss_pipe_destroy_msg,
1221 .release_pipe = gss_pipe_release,
1225 * Initialize RPCSEC_GSS module
1227 static int __init init_rpcsec_gss(void)
1231 err = rpcauth_register(&authgss_ops);
1234 err = gss_svc_init();
1236 goto out_unregister;
1239 rpcauth_unregister(&authgss_ops);
1244 static void __exit exit_rpcsec_gss(void)
1247 rpcauth_unregister(&authgss_ops);
1250 MODULE_LICENSE("GPL");
1251 module_init(init_rpcsec_gss)
1252 module_exit(exit_rpcsec_gss)