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.
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/types.h>
42 #include <linux/slab.h>
43 #include <linux/sched.h>
44 #include <linux/pagemap.h>
45 #include <linux/sunrpc/clnt.h>
46 #include <linux/sunrpc/auth.h>
47 #include <linux/sunrpc/auth_gss.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/gss_err.h>
50 #include <linux/workqueue.h>
51 #include <linux/sunrpc/rpc_pipe_fs.h>
52 #include <linux/sunrpc/gss_api.h>
53 #include <asm/uaccess.h>
55 static const struct rpc_authops authgss_ops;
57 static const struct rpc_credops gss_credops;
58 static const struct rpc_credops gss_nullops;
61 # define RPCDBG_FACILITY RPCDBG_AUTH
64 #define GSS_CRED_SLACK 1024
65 /* length of a krb5 verifier (48), plus data added before arguments when
66 * using integrity (two 4-byte integers): */
67 #define GSS_VERF_SLACK 100
71 struct rpc_auth rpc_auth;
72 struct gss_api_mech *mech;
73 enum rpc_gss_svc service;
74 struct rpc_clnt *client;
75 struct dentry *dentry;
78 static atomic_t pipe_users = ATOMIC_INIT(0);
80 static void gss_free_ctx(struct gss_cl_ctx *);
81 static struct rpc_pipe_ops gss_upcall_ops;
83 static inline struct gss_cl_ctx *
84 gss_get_ctx(struct gss_cl_ctx *ctx)
86 atomic_inc(&ctx->count);
91 gss_put_ctx(struct gss_cl_ctx *ctx)
93 if (atomic_dec_and_test(&ctx->count))
98 * called by gss_upcall_callback and gss_create_upcall in order
99 * to set the gss context. The actual exchange of an old context
100 * and a new one is protected by the inode->i_lock.
103 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
105 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
107 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
110 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
111 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
112 smp_mb__before_clear_bit();
113 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
117 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
119 const void *q = (const void *)((const char *)p + len);
120 if (unlikely(q > end || q < p))
121 return ERR_PTR(-EFAULT);
126 static inline const void *
127 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
132 p = simple_get_bytes(p, end, &len, sizeof(len));
135 q = (const void *)((const char *)p + len);
136 if (unlikely(q > end || q < p))
137 return ERR_PTR(-EFAULT);
138 dest->data = kmemdup(p, len, GFP_NOFS);
139 if (unlikely(dest->data == NULL))
140 return ERR_PTR(-ENOMEM);
145 static struct gss_cl_ctx *
146 gss_cred_get_ctx(struct rpc_cred *cred)
148 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
149 struct gss_cl_ctx *ctx = NULL;
152 if (gss_cred->gc_ctx)
153 ctx = gss_get_ctx(gss_cred->gc_ctx);
158 static struct gss_cl_ctx *
159 gss_alloc_context(void)
161 struct gss_cl_ctx *ctx;
163 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
165 ctx->gc_proc = RPC_GSS_PROC_DATA;
166 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
167 spin_lock_init(&ctx->gc_seq_lock);
168 atomic_set(&ctx->count,1);
173 #define GSSD_MIN_TIMEOUT (60 * 60)
175 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
179 unsigned int timeout;
183 /* First unsigned int gives the lifetime (in seconds) of the cred */
184 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
188 timeout = GSSD_MIN_TIMEOUT;
189 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
190 /* Sequence number window. Determines the maximum number of simultaneous requests */
191 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
194 ctx->gc_win = window_size;
195 /* gssd signals an error by passing ctx->gc_win = 0: */
196 if (ctx->gc_win == 0) {
197 /* in which case, p points to an error code which we ignore */
198 p = ERR_PTR(-EACCES);
201 /* copy the opaque wire context */
202 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
205 /* import the opaque security context */
206 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
209 q = (const void *)((const char *)p + seclen);
210 if (unlikely(q > end || q < p)) {
211 p = ERR_PTR(-EFAULT);
214 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
221 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
226 struct gss_upcall_msg {
229 struct rpc_pipe_msg msg;
230 struct list_head list;
231 struct gss_auth *auth;
232 struct rpc_wait_queue rpc_waitqueue;
233 wait_queue_head_t waitqueue;
234 struct gss_cl_ctx *ctx;
238 gss_release_msg(struct gss_upcall_msg *gss_msg)
240 if (!atomic_dec_and_test(&gss_msg->count))
242 atomic_dec(&pipe_users);
243 BUG_ON(!list_empty(&gss_msg->list));
244 if (gss_msg->ctx != NULL)
245 gss_put_ctx(gss_msg->ctx);
246 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
250 static struct gss_upcall_msg *
251 __gss_find_upcall(struct rpc_inode *rpci, uid_t uid)
253 struct gss_upcall_msg *pos;
254 list_for_each_entry(pos, &rpci->in_downcall, list) {
257 atomic_inc(&pos->count);
258 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
261 dprintk("RPC: gss_find_upcall found nothing\n");
265 /* Try to add an upcall to the pipefs queue.
266 * If an upcall owned by our uid already exists, then we return a reference
267 * to that upcall instead of adding the new upcall.
269 static inline struct gss_upcall_msg *
270 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
272 struct inode *inode = gss_auth->dentry->d_inode;
273 struct rpc_inode *rpci = RPC_I(inode);
274 struct gss_upcall_msg *old;
276 spin_lock(&inode->i_lock);
277 old = __gss_find_upcall(rpci, gss_msg->uid);
279 atomic_inc(&gss_msg->count);
280 list_add(&gss_msg->list, &rpci->in_downcall);
283 spin_unlock(&inode->i_lock);
288 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
290 list_del_init(&gss_msg->list);
291 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
292 wake_up_all(&gss_msg->waitqueue);
293 atomic_dec(&gss_msg->count);
297 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
299 struct gss_auth *gss_auth = gss_msg->auth;
300 struct inode *inode = gss_auth->dentry->d_inode;
302 if (list_empty(&gss_msg->list))
304 spin_lock(&inode->i_lock);
305 if (!list_empty(&gss_msg->list))
306 __gss_unhash_msg(gss_msg);
307 spin_unlock(&inode->i_lock);
311 gss_upcall_callback(struct rpc_task *task)
313 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
314 struct gss_cred, gc_base);
315 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
316 struct inode *inode = gss_msg->auth->dentry->d_inode;
318 spin_lock(&inode->i_lock);
320 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_msg->ctx);
322 task->tk_status = gss_msg->msg.errno;
323 gss_cred->gc_upcall = NULL;
324 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
325 spin_unlock(&inode->i_lock);
326 gss_release_msg(gss_msg);
329 static inline struct gss_upcall_msg *
330 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
332 struct gss_upcall_msg *gss_msg;
334 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
336 return ERR_PTR(-ENOMEM);
337 atomic_inc(&pipe_users);
338 INIT_LIST_HEAD(&gss_msg->list);
339 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
340 init_waitqueue_head(&gss_msg->waitqueue);
341 atomic_set(&gss_msg->count, 1);
342 gss_msg->msg.data = &gss_msg->uid;
343 gss_msg->msg.len = sizeof(gss_msg->uid);
345 gss_msg->auth = gss_auth;
349 static struct gss_upcall_msg *
350 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
352 struct gss_cred *gss_cred = container_of(cred,
353 struct gss_cred, gc_base);
354 struct gss_upcall_msg *gss_new, *gss_msg;
355 uid_t uid = cred->cr_uid;
357 /* Special case: rpc.gssd assumes that uid == 0 implies machine creds */
358 if (gss_cred->gc_machine_cred != 0)
361 gss_new = gss_alloc_msg(gss_auth, uid);
364 gss_msg = gss_add_msg(gss_auth, gss_new);
365 if (gss_msg == gss_new) {
366 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
368 gss_unhash_msg(gss_new);
369 gss_msg = ERR_PTR(res);
372 gss_release_msg(gss_new);
376 static void warn_gssd(void)
378 static unsigned long ratelimit;
379 unsigned long now = jiffies;
381 if (time_after(now, ratelimit)) {
382 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
383 "Please check user daemon is running.\n");
384 ratelimit = now + 15*HZ;
389 gss_refresh_upcall(struct rpc_task *task)
391 struct rpc_cred *cred = task->tk_msg.rpc_cred;
392 struct gss_auth *gss_auth = container_of(cred->cr_auth,
393 struct gss_auth, rpc_auth);
394 struct gss_cred *gss_cred = container_of(cred,
395 struct gss_cred, gc_base);
396 struct gss_upcall_msg *gss_msg;
397 struct inode *inode = gss_auth->dentry->d_inode;
400 dprintk("RPC: %5u gss_refresh_upcall for uid %u\n", task->tk_pid,
402 gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
403 if (IS_ERR(gss_msg)) {
404 err = PTR_ERR(gss_msg);
407 spin_lock(&inode->i_lock);
408 if (gss_cred->gc_upcall != NULL)
409 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
410 else if (gss_msg->ctx != NULL) {
411 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_msg->ctx);
412 gss_cred->gc_upcall = NULL;
413 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
414 } else if (gss_msg->msg.errno >= 0) {
415 task->tk_timeout = 0;
416 gss_cred->gc_upcall = gss_msg;
417 /* gss_upcall_callback will release the reference to gss_upcall_msg */
418 atomic_inc(&gss_msg->count);
419 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
421 err = gss_msg->msg.errno;
422 spin_unlock(&inode->i_lock);
423 gss_release_msg(gss_msg);
425 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
426 task->tk_pid, cred->cr_uid, err);
431 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
433 struct inode *inode = gss_auth->dentry->d_inode;
434 struct rpc_cred *cred = &gss_cred->gc_base;
435 struct gss_upcall_msg *gss_msg;
439 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
440 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
441 if (IS_ERR(gss_msg)) {
442 err = PTR_ERR(gss_msg);
446 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
447 spin_lock(&inode->i_lock);
448 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
451 spin_unlock(&inode->i_lock);
459 gss_cred_set_ctx(cred, gss_msg->ctx);
461 err = gss_msg->msg.errno;
462 spin_unlock(&inode->i_lock);
464 finish_wait(&gss_msg->waitqueue, &wait);
465 gss_release_msg(gss_msg);
467 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
473 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
474 char __user *dst, size_t buflen)
476 char *data = (char *)msg->data + msg->copied;
477 size_t mlen = min(msg->len, buflen);
480 left = copy_to_user(dst, data, mlen);
482 msg->errno = -EFAULT;
492 #define MSG_BUF_MAXSIZE 1024
495 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
499 struct gss_upcall_msg *gss_msg;
500 struct inode *inode = filp->f_path.dentry->d_inode;
501 struct gss_cl_ctx *ctx;
503 ssize_t err = -EFBIG;
505 if (mlen > MSG_BUF_MAXSIZE)
508 buf = kmalloc(mlen, GFP_NOFS);
513 if (copy_from_user(buf, src, mlen))
516 end = (const void *)((char *)buf + mlen);
517 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
524 ctx = gss_alloc_context();
529 /* Find a matching upcall */
530 spin_lock(&inode->i_lock);
531 gss_msg = __gss_find_upcall(RPC_I(inode), uid);
532 if (gss_msg == NULL) {
533 spin_unlock(&inode->i_lock);
536 list_del_init(&gss_msg->list);
537 spin_unlock(&inode->i_lock);
539 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
542 gss_msg->msg.errno = (err == -EAGAIN) ? -EAGAIN : -EACCES;
543 goto err_release_msg;
545 gss_msg->ctx = gss_get_ctx(ctx);
549 spin_lock(&inode->i_lock);
550 __gss_unhash_msg(gss_msg);
551 spin_unlock(&inode->i_lock);
552 gss_release_msg(gss_msg);
558 dprintk("RPC: gss_pipe_downcall returning %Zd\n", err);
563 gss_pipe_open(struct inode *inode)
565 atomic_inc(&pipe_users);
570 gss_pipe_release(struct inode *inode)
572 struct rpc_inode *rpci = RPC_I(inode);
573 struct gss_upcall_msg *gss_msg;
575 spin_lock(&inode->i_lock);
576 while (!list_empty(&rpci->in_downcall)) {
578 gss_msg = list_entry(rpci->in_downcall.next,
579 struct gss_upcall_msg, list);
580 gss_msg->msg.errno = -EPIPE;
581 atomic_inc(&gss_msg->count);
582 __gss_unhash_msg(gss_msg);
583 spin_unlock(&inode->i_lock);
584 gss_release_msg(gss_msg);
585 spin_lock(&inode->i_lock);
587 spin_unlock(&inode->i_lock);
589 atomic_dec(&pipe_users);
593 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
595 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
597 if (msg->errno < 0) {
598 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
600 atomic_inc(&gss_msg->count);
601 gss_unhash_msg(gss_msg);
602 if (msg->errno == -ETIMEDOUT)
604 gss_release_msg(gss_msg);
609 * NOTE: we have the opportunity to use different
610 * parameters based on the input flavor (which must be a pseudoflavor)
612 static struct rpc_auth *
613 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
615 struct gss_auth *gss_auth;
616 struct rpc_auth * auth;
617 int err = -ENOMEM; /* XXX? */
619 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
621 if (!try_module_get(THIS_MODULE))
623 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
625 gss_auth->client = clnt;
627 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
628 if (!gss_auth->mech) {
629 printk(KERN_WARNING "%s: Pseudoflavor %d not found!\n",
633 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
634 if (gss_auth->service == 0)
636 auth = &gss_auth->rpc_auth;
637 auth->au_cslack = GSS_CRED_SLACK >> 2;
638 auth->au_rslack = GSS_VERF_SLACK >> 2;
639 auth->au_ops = &authgss_ops;
640 auth->au_flavor = flavor;
641 atomic_set(&auth->au_count, 1);
642 kref_init(&gss_auth->kref);
644 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
645 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
646 if (IS_ERR(gss_auth->dentry)) {
647 err = PTR_ERR(gss_auth->dentry);
651 err = rpcauth_init_credcache(auth);
653 goto err_unlink_pipe;
657 rpc_unlink(gss_auth->dentry);
659 gss_mech_put(gss_auth->mech);
663 module_put(THIS_MODULE);
668 gss_free(struct gss_auth *gss_auth)
670 rpc_unlink(gss_auth->dentry);
671 gss_mech_put(gss_auth->mech);
674 module_put(THIS_MODULE);
678 gss_free_callback(struct kref *kref)
680 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
686 gss_destroy(struct rpc_auth *auth)
688 struct gss_auth *gss_auth;
690 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
691 auth, auth->au_flavor);
693 rpcauth_destroy_credcache(auth);
695 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
696 kref_put(&gss_auth->kref, gss_free_callback);
700 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
701 * to the server with the GSS control procedure field set to
702 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
703 * all RPCSEC_GSS state associated with that context.
706 gss_destroying_context(struct rpc_cred *cred)
708 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
709 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
710 struct rpc_task *task;
712 if (gss_cred->gc_ctx == NULL ||
713 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
716 gss_cred->gc_ctx->gc_proc = RPC_GSS_PROC_DESTROY;
717 cred->cr_ops = &gss_nullops;
719 /* Take a reference to ensure the cred will be destroyed either
720 * by the RPC call or by the put_rpccred() below */
723 task = rpc_call_null(gss_auth->client, cred, RPC_TASK_ASYNC|RPC_TASK_SOFT);
731 /* gss_destroy_cred (and gss_free_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_do_free_ctx(struct gss_cl_ctx *ctx)
737 dprintk("RPC: gss_free_ctx\n");
739 kfree(ctx->gc_wire_ctx.data);
744 gss_free_ctx_callback(struct rcu_head *head)
746 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
747 gss_do_free_ctx(ctx);
751 gss_free_ctx(struct gss_cl_ctx *ctx)
753 struct gss_ctx *gc_gss_ctx;
755 gc_gss_ctx = rcu_dereference(ctx->gc_gss_ctx);
756 rcu_assign_pointer(ctx->gc_gss_ctx, NULL);
757 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
759 gss_delete_sec_context(&gc_gss_ctx);
763 gss_free_cred(struct gss_cred *gss_cred)
765 dprintk("RPC: gss_free_cred %p\n", gss_cred);
770 gss_free_cred_callback(struct rcu_head *head)
772 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
773 gss_free_cred(gss_cred);
777 gss_destroy_nullcred(struct rpc_cred *cred)
779 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
780 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
781 struct gss_cl_ctx *ctx = gss_cred->gc_ctx;
783 rcu_assign_pointer(gss_cred->gc_ctx, NULL);
784 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
787 kref_put(&gss_auth->kref, gss_free_callback);
791 gss_destroy_cred(struct rpc_cred *cred)
794 if (gss_destroying_context(cred))
796 gss_destroy_nullcred(cred);
800 * Lookup RPCSEC_GSS cred for the current process
802 static struct rpc_cred *
803 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
805 return rpcauth_lookup_credcache(auth, acred, flags);
808 static struct rpc_cred *
809 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
811 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
812 struct gss_cred *cred = NULL;
815 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
816 acred->uid, auth->au_flavor);
818 if (!(cred = kzalloc(sizeof(*cred), GFP_NOFS)))
821 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
823 * Note: in order to force a call to call_refresh(), we deliberately
824 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
826 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
827 cred->gc_service = gss_auth->service;
828 cred->gc_machine_cred = acred->machine_cred;
829 kref_get(&gss_auth->kref);
830 return &cred->gc_base;
833 dprintk("RPC: gss_create_cred failed with error %d\n", err);
838 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
840 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
841 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
845 err = gss_create_upcall(gss_auth, gss_cred);
846 } while (err == -EAGAIN);
851 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
853 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
855 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
857 /* Don't match with creds that have expired. */
858 if (time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
860 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
863 if (acred->machine_cred != gss_cred->gc_machine_cred)
865 return (rc->cr_uid == acred->uid);
869 * Marshal credentials.
870 * Maybe we should keep a cached credential for performance reasons.
873 gss_marshal(struct rpc_task *task, __be32 *p)
875 struct rpc_cred *cred = task->tk_msg.rpc_cred;
876 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
878 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
880 struct rpc_rqst *req = task->tk_rqstp;
882 struct xdr_netobj mic;
884 struct xdr_buf verf_buf;
886 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
888 *p++ = htonl(RPC_AUTH_GSS);
891 spin_lock(&ctx->gc_seq_lock);
892 req->rq_seqno = ctx->gc_seq++;
893 spin_unlock(&ctx->gc_seq_lock);
895 *p++ = htonl((u32) RPC_GSS_VERSION);
896 *p++ = htonl((u32) ctx->gc_proc);
897 *p++ = htonl((u32) req->rq_seqno);
898 *p++ = htonl((u32) gss_cred->gc_service);
899 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
900 *cred_len = htonl((p - (cred_len + 1)) << 2);
902 /* We compute the checksum for the verifier over the xdr-encoded bytes
903 * starting with the xid and ending at the end of the credential: */
904 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
905 req->rq_snd_buf.head[0].iov_base);
906 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
907 xdr_buf_from_iov(&iov, &verf_buf);
909 /* set verifier flavor*/
910 *p++ = htonl(RPC_AUTH_GSS);
912 mic.data = (u8 *)(p + 1);
913 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
914 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
915 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
916 } else if (maj_stat != 0) {
917 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
920 p = xdr_encode_opaque(p, NULL, mic.len);
928 static int gss_renew_cred(struct rpc_task *task)
930 struct rpc_cred *oldcred = task->tk_msg.rpc_cred;
931 struct gss_cred *gss_cred = container_of(oldcred,
934 struct rpc_auth *auth = oldcred->cr_auth;
935 struct auth_cred acred = {
936 .uid = oldcred->cr_uid,
937 .machine_cred = gss_cred->gc_machine_cred,
939 struct rpc_cred *new;
941 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
944 task->tk_msg.rpc_cred = new;
945 put_rpccred(oldcred);
950 * Refresh credentials. XXX - finish
953 gss_refresh(struct rpc_task *task)
955 struct rpc_cred *cred = task->tk_msg.rpc_cred;
958 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
959 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
960 ret = gss_renew_cred(task);
963 cred = task->tk_msg.rpc_cred;
966 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
967 ret = gss_refresh_upcall(task);
972 /* Dummy refresh routine: used only when destroying the context */
974 gss_refresh_null(struct rpc_task *task)
980 gss_validate(struct rpc_task *task, __be32 *p)
982 struct rpc_cred *cred = task->tk_msg.rpc_cred;
983 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
986 struct xdr_buf verf_buf;
987 struct xdr_netobj mic;
991 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
994 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
996 if (flav != RPC_AUTH_GSS)
998 seq = htonl(task->tk_rqstp->rq_seqno);
1000 iov.iov_len = sizeof(seq);
1001 xdr_buf_from_iov(&iov, &verf_buf);
1005 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1006 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1007 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1009 dprintk("RPC: %5u gss_validate: gss_verify_mic returned "
1010 "error 0x%08x\n", task->tk_pid, maj_stat);
1013 /* We leave it to unwrap to calculate au_rslack. For now we just
1014 * calculate the length of the verifier: */
1015 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1017 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
1019 return p + XDR_QUADLEN(len);
1022 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
1027 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1028 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1030 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1031 struct xdr_buf integ_buf;
1032 __be32 *integ_len = NULL;
1033 struct xdr_netobj mic;
1041 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1042 *p++ = htonl(rqstp->rq_seqno);
1044 status = encode(rqstp, p, obj);
1048 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1049 offset, snd_buf->len - offset))
1051 *integ_len = htonl(integ_buf.len);
1053 /* guess whether we're in the head or the tail: */
1054 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1055 iov = snd_buf->tail;
1057 iov = snd_buf->head;
1058 p = iov->iov_base + iov->iov_len;
1059 mic.data = (u8 *)(p + 1);
1061 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1062 status = -EIO; /* XXX? */
1063 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1064 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1067 q = xdr_encode_opaque(p, NULL, mic.len);
1069 offset = (u8 *)q - (u8 *)p;
1070 iov->iov_len += offset;
1071 snd_buf->len += offset;
1076 priv_release_snd_buf(struct rpc_rqst *rqstp)
1080 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1081 __free_page(rqstp->rq_enc_pages[i]);
1082 kfree(rqstp->rq_enc_pages);
1086 alloc_enc_pages(struct rpc_rqst *rqstp)
1088 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1091 if (snd_buf->page_len == 0) {
1092 rqstp->rq_enc_pages_num = 0;
1096 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1097 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1098 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1100 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1102 if (!rqstp->rq_enc_pages)
1104 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1105 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1106 if (rqstp->rq_enc_pages[i] == NULL)
1109 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1112 for (i--; i >= 0; i--) {
1113 __free_page(rqstp->rq_enc_pages[i]);
1120 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1121 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1123 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1128 struct page **inpages;
1135 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1136 *p++ = htonl(rqstp->rq_seqno);
1138 status = encode(rqstp, p, obj);
1142 status = alloc_enc_pages(rqstp);
1145 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1146 inpages = snd_buf->pages + first;
1147 snd_buf->pages = rqstp->rq_enc_pages;
1148 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1149 /* Give the tail its own page, in case we need extra space in the
1150 * head when wrapping: */
1151 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1152 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1153 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1154 snd_buf->tail[0].iov_base = tmp;
1156 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1157 /* RPC_SLACK_SPACE should prevent this ever happening: */
1158 BUG_ON(snd_buf->len > snd_buf->buflen);
1160 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1161 * done anyway, so it's safe to put the request on the wire: */
1162 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1163 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1167 *opaque_len = htonl(snd_buf->len - offset);
1168 /* guess whether we're in the head or the tail: */
1169 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1170 iov = snd_buf->tail;
1172 iov = snd_buf->head;
1173 p = iov->iov_base + iov->iov_len;
1174 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1176 iov->iov_len += pad;
1177 snd_buf->len += pad;
1183 gss_wrap_req(struct rpc_task *task,
1184 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1186 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1187 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1189 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1192 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1193 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1194 /* The spec seems a little ambiguous here, but I think that not
1195 * wrapping context destruction requests makes the most sense.
1197 status = encode(rqstp, p, obj);
1200 switch (gss_cred->gc_service) {
1201 case RPC_GSS_SVC_NONE:
1202 status = encode(rqstp, p, obj);
1204 case RPC_GSS_SVC_INTEGRITY:
1205 status = gss_wrap_req_integ(cred, ctx, encode,
1208 case RPC_GSS_SVC_PRIVACY:
1209 status = gss_wrap_req_priv(cred, ctx, encode,
1215 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1220 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1221 struct rpc_rqst *rqstp, __be32 **p)
1223 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1224 struct xdr_buf integ_buf;
1225 struct xdr_netobj mic;
1226 u32 data_offset, mic_offset;
1231 integ_len = ntohl(*(*p)++);
1234 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1235 mic_offset = integ_len + data_offset;
1236 if (mic_offset > rcv_buf->len)
1238 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1241 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1242 mic_offset - data_offset))
1245 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1248 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1249 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1250 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1251 if (maj_stat != GSS_S_COMPLETE)
1257 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1258 struct rpc_rqst *rqstp, __be32 **p)
1260 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1266 opaque_len = ntohl(*(*p)++);
1267 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1268 if (offset + opaque_len > rcv_buf->len)
1270 /* remove padding: */
1271 rcv_buf->len = offset + opaque_len;
1273 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1274 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1275 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1276 if (maj_stat != GSS_S_COMPLETE)
1278 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1286 gss_unwrap_resp(struct rpc_task *task,
1287 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1289 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1290 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1292 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1294 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1295 int savedlen = head->iov_len;
1298 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1300 switch (gss_cred->gc_service) {
1301 case RPC_GSS_SVC_NONE:
1303 case RPC_GSS_SVC_INTEGRITY:
1304 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1308 case RPC_GSS_SVC_PRIVACY:
1309 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1314 /* take into account extra slack for integrity and privacy cases: */
1315 cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
1316 + (savedlen - head->iov_len);
1318 status = decode(rqstp, p, obj);
1321 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1326 static const struct rpc_authops authgss_ops = {
1327 .owner = THIS_MODULE,
1328 .au_flavor = RPC_AUTH_GSS,
1329 .au_name = "RPCSEC_GSS",
1330 .create = gss_create,
1331 .destroy = gss_destroy,
1332 .lookup_cred = gss_lookup_cred,
1333 .crcreate = gss_create_cred
1336 static const struct rpc_credops gss_credops = {
1337 .cr_name = "AUTH_GSS",
1338 .crdestroy = gss_destroy_cred,
1339 .cr_init = gss_cred_init,
1340 .crbind = rpcauth_generic_bind_cred,
1341 .crmatch = gss_match,
1342 .crmarshal = gss_marshal,
1343 .crrefresh = gss_refresh,
1344 .crvalidate = gss_validate,
1345 .crwrap_req = gss_wrap_req,
1346 .crunwrap_resp = gss_unwrap_resp,
1349 static const struct rpc_credops gss_nullops = {
1350 .cr_name = "AUTH_GSS",
1351 .crdestroy = gss_destroy_nullcred,
1352 .crbind = rpcauth_generic_bind_cred,
1353 .crmatch = gss_match,
1354 .crmarshal = gss_marshal,
1355 .crrefresh = gss_refresh_null,
1356 .crvalidate = gss_validate,
1357 .crwrap_req = gss_wrap_req,
1358 .crunwrap_resp = gss_unwrap_resp,
1361 static struct rpc_pipe_ops gss_upcall_ops = {
1362 .upcall = gss_pipe_upcall,
1363 .downcall = gss_pipe_downcall,
1364 .destroy_msg = gss_pipe_destroy_msg,
1365 .open_pipe = gss_pipe_open,
1366 .release_pipe = gss_pipe_release,
1370 * Initialize RPCSEC_GSS module
1372 static int __init init_rpcsec_gss(void)
1376 err = rpcauth_register(&authgss_ops);
1379 err = gss_svc_init();
1381 goto out_unregister;
1384 rpcauth_unregister(&authgss_ops);
1389 static void __exit exit_rpcsec_gss(void)
1392 rpcauth_unregister(&authgss_ops);
1395 MODULE_LICENSE("GPL");
1396 module_init(init_rpcsec_gss)
1397 module_exit(exit_rpcsec_gss)