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 void gss_free_ctx(struct gss_cl_ctx *);
79 static struct rpc_pipe_ops gss_upcall_ops;
81 static inline struct gss_cl_ctx *
82 gss_get_ctx(struct gss_cl_ctx *ctx)
84 atomic_inc(&ctx->count);
89 gss_put_ctx(struct gss_cl_ctx *ctx)
91 if (atomic_dec_and_test(&ctx->count))
96 * called by gss_upcall_callback and gss_create_upcall in order
97 * to set the gss context. The actual exchange of an old context
98 * and a new one is protected by the inode->i_lock.
101 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
103 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
105 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
108 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
109 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
110 smp_mb__before_clear_bit();
111 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
115 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
117 const void *q = (const void *)((const char *)p + len);
118 if (unlikely(q > end || q < p))
119 return ERR_PTR(-EFAULT);
124 static inline const void *
125 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
130 p = simple_get_bytes(p, end, &len, sizeof(len));
133 q = (const void *)((const char *)p + len);
134 if (unlikely(q > end || q < p))
135 return ERR_PTR(-EFAULT);
136 dest->data = kmemdup(p, len, GFP_NOFS);
137 if (unlikely(dest->data == NULL))
138 return ERR_PTR(-ENOMEM);
143 static struct gss_cl_ctx *
144 gss_cred_get_ctx(struct rpc_cred *cred)
146 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
147 struct gss_cl_ctx *ctx = NULL;
150 if (gss_cred->gc_ctx)
151 ctx = gss_get_ctx(gss_cred->gc_ctx);
156 static struct gss_cl_ctx *
157 gss_alloc_context(void)
159 struct gss_cl_ctx *ctx;
161 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
163 ctx->gc_proc = RPC_GSS_PROC_DATA;
164 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
165 spin_lock_init(&ctx->gc_seq_lock);
166 atomic_set(&ctx->count,1);
171 #define GSSD_MIN_TIMEOUT (60 * 60)
173 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
177 unsigned int timeout;
181 /* First unsigned int gives the lifetime (in seconds) of the cred */
182 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
186 timeout = GSSD_MIN_TIMEOUT;
187 ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
188 /* Sequence number window. Determines the maximum number of simultaneous requests */
189 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
192 ctx->gc_win = window_size;
193 /* gssd signals an error by passing ctx->gc_win = 0: */
194 if (ctx->gc_win == 0) {
195 /* in which case, p points to an error code which we ignore */
196 p = ERR_PTR(-EACCES);
199 /* copy the opaque wire context */
200 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
203 /* import the opaque security context */
204 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
207 q = (const void *)((const char *)p + seclen);
208 if (unlikely(q > end || q < p)) {
209 p = ERR_PTR(-EFAULT);
212 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
219 dprintk("RPC: gss_fill_context returning %ld\n", -PTR_ERR(p));
224 struct gss_upcall_msg {
227 struct rpc_pipe_msg msg;
228 struct list_head list;
229 struct gss_auth *auth;
230 struct rpc_wait_queue rpc_waitqueue;
231 wait_queue_head_t waitqueue;
232 struct gss_cl_ctx *ctx;
236 gss_release_msg(struct gss_upcall_msg *gss_msg)
238 if (!atomic_dec_and_test(&gss_msg->count))
240 BUG_ON(!list_empty(&gss_msg->list));
241 if (gss_msg->ctx != NULL)
242 gss_put_ctx(gss_msg->ctx);
243 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
247 static struct gss_upcall_msg *
248 __gss_find_upcall(struct rpc_inode *rpci, uid_t uid)
250 struct gss_upcall_msg *pos;
251 list_for_each_entry(pos, &rpci->in_downcall, list) {
254 atomic_inc(&pos->count);
255 dprintk("RPC: gss_find_upcall found msg %p\n", pos);
258 dprintk("RPC: gss_find_upcall found nothing\n");
262 /* Try to add an upcall to the pipefs queue.
263 * If an upcall owned by our uid already exists, then we return a reference
264 * to that upcall instead of adding the new upcall.
266 static inline struct gss_upcall_msg *
267 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
269 struct inode *inode = gss_auth->dentry->d_inode;
270 struct rpc_inode *rpci = RPC_I(inode);
271 struct gss_upcall_msg *old;
273 spin_lock(&inode->i_lock);
274 old = __gss_find_upcall(rpci, gss_msg->uid);
276 atomic_inc(&gss_msg->count);
277 list_add(&gss_msg->list, &rpci->in_downcall);
280 spin_unlock(&inode->i_lock);
285 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
287 list_del_init(&gss_msg->list);
288 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
289 wake_up_all(&gss_msg->waitqueue);
290 atomic_dec(&gss_msg->count);
294 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
296 struct gss_auth *gss_auth = gss_msg->auth;
297 struct inode *inode = gss_auth->dentry->d_inode;
299 if (list_empty(&gss_msg->list))
301 spin_lock(&inode->i_lock);
302 if (!list_empty(&gss_msg->list))
303 __gss_unhash_msg(gss_msg);
304 spin_unlock(&inode->i_lock);
308 gss_upcall_callback(struct rpc_task *task)
310 struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
311 struct gss_cred, gc_base);
312 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
313 struct inode *inode = gss_msg->auth->dentry->d_inode;
315 spin_lock(&inode->i_lock);
317 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_msg->ctx);
319 task->tk_status = gss_msg->msg.errno;
320 gss_cred->gc_upcall = NULL;
321 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
322 spin_unlock(&inode->i_lock);
323 gss_release_msg(gss_msg);
326 static inline struct gss_upcall_msg *
327 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
329 struct gss_upcall_msg *gss_msg;
331 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
332 if (gss_msg != NULL) {
333 INIT_LIST_HEAD(&gss_msg->list);
334 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
335 init_waitqueue_head(&gss_msg->waitqueue);
336 atomic_set(&gss_msg->count, 1);
337 gss_msg->msg.data = &gss_msg->uid;
338 gss_msg->msg.len = sizeof(gss_msg->uid);
340 gss_msg->auth = gss_auth;
345 static struct gss_upcall_msg *
346 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
348 struct gss_cred *gss_cred = container_of(cred,
349 struct gss_cred, gc_base);
350 struct gss_upcall_msg *gss_new, *gss_msg;
351 uid_t uid = cred->cr_uid;
353 /* Special case: rpc.gssd assumes that uid == 0 implies machine creds */
354 if (gss_cred->gc_machine_cred != 0)
357 gss_new = gss_alloc_msg(gss_auth, uid);
359 return ERR_PTR(-ENOMEM);
360 gss_msg = gss_add_msg(gss_auth, gss_new);
361 if (gss_msg == gss_new) {
362 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
364 gss_unhash_msg(gss_new);
365 gss_msg = ERR_PTR(res);
368 gss_release_msg(gss_new);
372 static void warn_gssd(void)
374 static unsigned long ratelimit;
375 unsigned long now = jiffies;
377 if (time_after(now, ratelimit)) {
378 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
379 "Please check user daemon is running.\n");
380 ratelimit = now + 15*HZ;
385 gss_refresh_upcall(struct rpc_task *task)
387 struct rpc_cred *cred = task->tk_msg.rpc_cred;
388 struct gss_auth *gss_auth = container_of(cred->cr_auth,
389 struct gss_auth, rpc_auth);
390 struct gss_cred *gss_cred = container_of(cred,
391 struct gss_cred, gc_base);
392 struct gss_upcall_msg *gss_msg;
393 struct inode *inode = gss_auth->dentry->d_inode;
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(&inode->i_lock);
404 if (gss_cred->gc_upcall != NULL)
405 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
406 else if (gss_msg->ctx != NULL) {
407 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_msg->ctx);
408 gss_cred->gc_upcall = NULL;
409 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
410 } else if (gss_msg->msg.errno >= 0) {
411 task->tk_timeout = 0;
412 gss_cred->gc_upcall = gss_msg;
413 /* gss_upcall_callback will release the reference to gss_upcall_msg */
414 atomic_inc(&gss_msg->count);
415 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
417 err = gss_msg->msg.errno;
418 spin_unlock(&inode->i_lock);
419 gss_release_msg(gss_msg);
421 dprintk("RPC: %5u gss_refresh_upcall for uid %u result %d\n",
422 task->tk_pid, cred->cr_uid, err);
427 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
429 struct inode *inode = gss_auth->dentry->d_inode;
430 struct rpc_cred *cred = &gss_cred->gc_base;
431 struct gss_upcall_msg *gss_msg;
435 dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
436 gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
437 if (IS_ERR(gss_msg)) {
438 err = PTR_ERR(gss_msg);
442 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
443 spin_lock(&inode->i_lock);
444 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
447 spin_unlock(&inode->i_lock);
455 gss_cred_set_ctx(cred, gss_msg->ctx);
457 err = gss_msg->msg.errno;
458 spin_unlock(&inode->i_lock);
460 finish_wait(&gss_msg->waitqueue, &wait);
461 gss_release_msg(gss_msg);
463 dprintk("RPC: gss_create_upcall for uid %u result %d\n",
469 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
470 char __user *dst, size_t buflen)
472 char *data = (char *)msg->data + msg->copied;
473 size_t mlen = min(msg->len, buflen);
476 left = copy_to_user(dst, data, mlen);
478 msg->errno = -EFAULT;
488 #define MSG_BUF_MAXSIZE 1024
491 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
495 struct gss_upcall_msg *gss_msg;
496 struct inode *inode = filp->f_path.dentry->d_inode;
497 struct gss_cl_ctx *ctx;
499 ssize_t err = -EFBIG;
501 if (mlen > MSG_BUF_MAXSIZE)
504 buf = kmalloc(mlen, GFP_NOFS);
509 if (copy_from_user(buf, src, mlen))
512 end = (const void *)((char *)buf + mlen);
513 p = simple_get_bytes(buf, end, &uid, sizeof(uid));
520 ctx = gss_alloc_context();
525 /* Find a matching upcall */
526 spin_lock(&inode->i_lock);
527 gss_msg = __gss_find_upcall(RPC_I(inode), uid);
528 if (gss_msg == NULL) {
529 spin_unlock(&inode->i_lock);
532 list_del_init(&gss_msg->list);
533 spin_unlock(&inode->i_lock);
535 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
538 gss_msg->msg.errno = (err == -EAGAIN) ? -EAGAIN : -EACCES;
539 goto err_release_msg;
541 gss_msg->ctx = gss_get_ctx(ctx);
545 spin_lock(&inode->i_lock);
546 __gss_unhash_msg(gss_msg);
547 spin_unlock(&inode->i_lock);
548 gss_release_msg(gss_msg);
554 dprintk("RPC: gss_pipe_downcall returning %Zd\n", err);
559 gss_pipe_release(struct inode *inode)
561 struct rpc_inode *rpci = RPC_I(inode);
562 struct gss_upcall_msg *gss_msg;
564 spin_lock(&inode->i_lock);
565 while (!list_empty(&rpci->in_downcall)) {
567 gss_msg = list_entry(rpci->in_downcall.next,
568 struct gss_upcall_msg, list);
569 gss_msg->msg.errno = -EPIPE;
570 atomic_inc(&gss_msg->count);
571 __gss_unhash_msg(gss_msg);
572 spin_unlock(&inode->i_lock);
573 gss_release_msg(gss_msg);
574 spin_lock(&inode->i_lock);
576 spin_unlock(&inode->i_lock);
580 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
582 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
584 if (msg->errno < 0) {
585 dprintk("RPC: gss_pipe_destroy_msg releasing msg %p\n",
587 atomic_inc(&gss_msg->count);
588 gss_unhash_msg(gss_msg);
589 if (msg->errno == -ETIMEDOUT)
591 gss_release_msg(gss_msg);
596 * NOTE: we have the opportunity to use different
597 * parameters based on the input flavor (which must be a pseudoflavor)
599 static struct rpc_auth *
600 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
602 struct gss_auth *gss_auth;
603 struct rpc_auth * auth;
604 int err = -ENOMEM; /* XXX? */
606 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
608 if (!try_module_get(THIS_MODULE))
610 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
612 gss_auth->client = clnt;
614 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
615 if (!gss_auth->mech) {
616 printk(KERN_WARNING "%s: Pseudoflavor %d not found!\n",
620 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
621 if (gss_auth->service == 0)
623 auth = &gss_auth->rpc_auth;
624 auth->au_cslack = GSS_CRED_SLACK >> 2;
625 auth->au_rslack = GSS_VERF_SLACK >> 2;
626 auth->au_ops = &authgss_ops;
627 auth->au_flavor = flavor;
628 atomic_set(&auth->au_count, 1);
629 kref_init(&gss_auth->kref);
631 gss_auth->dentry = rpc_mkpipe(clnt->cl_dentry, gss_auth->mech->gm_name,
632 clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
633 if (IS_ERR(gss_auth->dentry)) {
634 err = PTR_ERR(gss_auth->dentry);
638 err = rpcauth_init_credcache(auth);
640 goto err_unlink_pipe;
644 rpc_unlink(gss_auth->dentry);
646 gss_mech_put(gss_auth->mech);
650 module_put(THIS_MODULE);
655 gss_free(struct gss_auth *gss_auth)
657 rpc_unlink(gss_auth->dentry);
658 gss_mech_put(gss_auth->mech);
661 module_put(THIS_MODULE);
665 gss_free_callback(struct kref *kref)
667 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
673 gss_destroy(struct rpc_auth *auth)
675 struct gss_auth *gss_auth;
677 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
678 auth, auth->au_flavor);
680 rpcauth_destroy_credcache(auth);
682 gss_auth = container_of(auth, struct gss_auth, rpc_auth);
683 kref_put(&gss_auth->kref, gss_free_callback);
687 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
688 * to the server with the GSS control procedure field set to
689 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
690 * all RPCSEC_GSS state associated with that context.
693 gss_destroying_context(struct rpc_cred *cred)
695 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
696 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
697 struct rpc_task *task;
699 if (gss_cred->gc_ctx == NULL ||
700 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
703 gss_cred->gc_ctx->gc_proc = RPC_GSS_PROC_DESTROY;
704 cred->cr_ops = &gss_nullops;
706 /* Take a reference to ensure the cred will be destroyed either
707 * by the RPC call or by the put_rpccred() below */
710 task = rpc_call_null(gss_auth->client, cred, RPC_TASK_ASYNC|RPC_TASK_SOFT);
718 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
719 * to create a new cred or context, so they check that things have been
720 * allocated before freeing them. */
722 gss_do_free_ctx(struct gss_cl_ctx *ctx)
724 dprintk("RPC: gss_free_ctx\n");
726 kfree(ctx->gc_wire_ctx.data);
731 gss_free_ctx_callback(struct rcu_head *head)
733 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
734 gss_do_free_ctx(ctx);
738 gss_free_ctx(struct gss_cl_ctx *ctx)
740 struct gss_ctx *gc_gss_ctx;
742 gc_gss_ctx = rcu_dereference(ctx->gc_gss_ctx);
743 rcu_assign_pointer(ctx->gc_gss_ctx, NULL);
744 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
746 gss_delete_sec_context(&gc_gss_ctx);
750 gss_free_cred(struct gss_cred *gss_cred)
752 dprintk("RPC: gss_free_cred %p\n", gss_cred);
757 gss_free_cred_callback(struct rcu_head *head)
759 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
760 gss_free_cred(gss_cred);
764 gss_destroy_nullcred(struct rpc_cred *cred)
766 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
767 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
768 struct gss_cl_ctx *ctx = gss_cred->gc_ctx;
770 rcu_assign_pointer(gss_cred->gc_ctx, NULL);
771 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
774 kref_put(&gss_auth->kref, gss_free_callback);
778 gss_destroy_cred(struct rpc_cred *cred)
781 if (gss_destroying_context(cred))
783 gss_destroy_nullcred(cred);
787 * Lookup RPCSEC_GSS cred for the current process
789 static struct rpc_cred *
790 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
792 return rpcauth_lookup_credcache(auth, acred, flags);
795 static struct rpc_cred *
796 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
798 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
799 struct gss_cred *cred = NULL;
802 dprintk("RPC: gss_create_cred for uid %d, flavor %d\n",
803 acred->uid, auth->au_flavor);
805 if (!(cred = kzalloc(sizeof(*cred), GFP_NOFS)))
808 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
810 * Note: in order to force a call to call_refresh(), we deliberately
811 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
813 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
814 cred->gc_service = gss_auth->service;
815 cred->gc_machine_cred = acred->machine_cred;
816 kref_get(&gss_auth->kref);
817 return &cred->gc_base;
820 dprintk("RPC: gss_create_cred failed with error %d\n", err);
825 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
827 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
828 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
832 err = gss_create_upcall(gss_auth, gss_cred);
833 } while (err == -EAGAIN);
838 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
840 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
842 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
844 /* Don't match with creds that have expired. */
845 if (time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
847 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
850 if (acred->machine_cred != gss_cred->gc_machine_cred)
852 return (rc->cr_uid == acred->uid);
856 * Marshal credentials.
857 * Maybe we should keep a cached credential for performance reasons.
860 gss_marshal(struct rpc_task *task, __be32 *p)
862 struct rpc_cred *cred = task->tk_msg.rpc_cred;
863 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
865 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
867 struct rpc_rqst *req = task->tk_rqstp;
869 struct xdr_netobj mic;
871 struct xdr_buf verf_buf;
873 dprintk("RPC: %5u gss_marshal\n", task->tk_pid);
875 *p++ = htonl(RPC_AUTH_GSS);
878 spin_lock(&ctx->gc_seq_lock);
879 req->rq_seqno = ctx->gc_seq++;
880 spin_unlock(&ctx->gc_seq_lock);
882 *p++ = htonl((u32) RPC_GSS_VERSION);
883 *p++ = htonl((u32) ctx->gc_proc);
884 *p++ = htonl((u32) req->rq_seqno);
885 *p++ = htonl((u32) gss_cred->gc_service);
886 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
887 *cred_len = htonl((p - (cred_len + 1)) << 2);
889 /* We compute the checksum for the verifier over the xdr-encoded bytes
890 * starting with the xid and ending at the end of the credential: */
891 iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
892 req->rq_snd_buf.head[0].iov_base);
893 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
894 xdr_buf_from_iov(&iov, &verf_buf);
896 /* set verifier flavor*/
897 *p++ = htonl(RPC_AUTH_GSS);
899 mic.data = (u8 *)(p + 1);
900 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
901 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
902 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
903 } else if (maj_stat != 0) {
904 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
907 p = xdr_encode_opaque(p, NULL, mic.len);
915 static int gss_renew_cred(struct rpc_task *task)
917 struct rpc_cred *oldcred = task->tk_msg.rpc_cred;
918 struct gss_cred *gss_cred = container_of(oldcred,
921 struct rpc_auth *auth = oldcred->cr_auth;
922 struct auth_cred acred = {
923 .uid = oldcred->cr_uid,
924 .machine_cred = gss_cred->gc_machine_cred,
926 struct rpc_cred *new;
928 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
931 task->tk_msg.rpc_cred = new;
932 put_rpccred(oldcred);
937 * Refresh credentials. XXX - finish
940 gss_refresh(struct rpc_task *task)
942 struct rpc_cred *cred = task->tk_msg.rpc_cred;
945 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
946 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
947 ret = gss_renew_cred(task);
950 cred = task->tk_msg.rpc_cred;
953 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
954 ret = gss_refresh_upcall(task);
959 /* Dummy refresh routine: used only when destroying the context */
961 gss_refresh_null(struct rpc_task *task)
967 gss_validate(struct rpc_task *task, __be32 *p)
969 struct rpc_cred *cred = task->tk_msg.rpc_cred;
970 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
973 struct xdr_buf verf_buf;
974 struct xdr_netobj mic;
978 dprintk("RPC: %5u gss_validate\n", task->tk_pid);
981 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
983 if (flav != RPC_AUTH_GSS)
985 seq = htonl(task->tk_rqstp->rq_seqno);
987 iov.iov_len = sizeof(seq);
988 xdr_buf_from_iov(&iov, &verf_buf);
992 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
993 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
994 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
996 dprintk("RPC: %5u gss_validate: gss_verify_mic returned "
997 "error 0x%08x\n", task->tk_pid, maj_stat);
1000 /* We leave it to unwrap to calculate au_rslack. For now we just
1001 * calculate the length of the verifier: */
1002 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1004 dprintk("RPC: %5u gss_validate: gss_verify_mic succeeded.\n",
1006 return p + XDR_QUADLEN(len);
1009 dprintk("RPC: %5u gss_validate failed.\n", task->tk_pid);
1014 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1015 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1017 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1018 struct xdr_buf integ_buf;
1019 __be32 *integ_len = NULL;
1020 struct xdr_netobj mic;
1028 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1029 *p++ = htonl(rqstp->rq_seqno);
1031 status = encode(rqstp, p, obj);
1035 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1036 offset, snd_buf->len - offset))
1038 *integ_len = htonl(integ_buf.len);
1040 /* guess whether we're in the head or the tail: */
1041 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1042 iov = snd_buf->tail;
1044 iov = snd_buf->head;
1045 p = iov->iov_base + iov->iov_len;
1046 mic.data = (u8 *)(p + 1);
1048 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1049 status = -EIO; /* XXX? */
1050 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1051 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1054 q = xdr_encode_opaque(p, NULL, mic.len);
1056 offset = (u8 *)q - (u8 *)p;
1057 iov->iov_len += offset;
1058 snd_buf->len += offset;
1063 priv_release_snd_buf(struct rpc_rqst *rqstp)
1067 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1068 __free_page(rqstp->rq_enc_pages[i]);
1069 kfree(rqstp->rq_enc_pages);
1073 alloc_enc_pages(struct rpc_rqst *rqstp)
1075 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1078 if (snd_buf->page_len == 0) {
1079 rqstp->rq_enc_pages_num = 0;
1083 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1084 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1085 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1087 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1089 if (!rqstp->rq_enc_pages)
1091 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1092 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1093 if (rqstp->rq_enc_pages[i] == NULL)
1096 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1099 for (i--; i >= 0; i--) {
1100 __free_page(rqstp->rq_enc_pages[i]);
1107 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1108 kxdrproc_t encode, struct rpc_rqst *rqstp, __be32 *p, void *obj)
1110 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1115 struct page **inpages;
1122 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1123 *p++ = htonl(rqstp->rq_seqno);
1125 status = encode(rqstp, p, obj);
1129 status = alloc_enc_pages(rqstp);
1132 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1133 inpages = snd_buf->pages + first;
1134 snd_buf->pages = rqstp->rq_enc_pages;
1135 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1136 /* Give the tail its own page, in case we need extra space in the
1137 * head when wrapping: */
1138 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1139 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1140 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1141 snd_buf->tail[0].iov_base = tmp;
1143 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1144 /* RPC_SLACK_SPACE should prevent this ever happening: */
1145 BUG_ON(snd_buf->len > snd_buf->buflen);
1147 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1148 * done anyway, so it's safe to put the request on the wire: */
1149 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1150 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1154 *opaque_len = htonl(snd_buf->len - offset);
1155 /* guess whether we're in the head or the tail: */
1156 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1157 iov = snd_buf->tail;
1159 iov = snd_buf->head;
1160 p = iov->iov_base + iov->iov_len;
1161 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1163 iov->iov_len += pad;
1164 snd_buf->len += pad;
1170 gss_wrap_req(struct rpc_task *task,
1171 kxdrproc_t encode, void *rqstp, __be32 *p, void *obj)
1173 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1174 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1176 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1179 dprintk("RPC: %5u gss_wrap_req\n", task->tk_pid);
1180 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1181 /* The spec seems a little ambiguous here, but I think that not
1182 * wrapping context destruction requests makes the most sense.
1184 status = encode(rqstp, p, obj);
1187 switch (gss_cred->gc_service) {
1188 case RPC_GSS_SVC_NONE:
1189 status = encode(rqstp, p, obj);
1191 case RPC_GSS_SVC_INTEGRITY:
1192 status = gss_wrap_req_integ(cred, ctx, encode,
1195 case RPC_GSS_SVC_PRIVACY:
1196 status = gss_wrap_req_priv(cred, ctx, encode,
1202 dprintk("RPC: %5u gss_wrap_req returning %d\n", task->tk_pid, status);
1207 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1208 struct rpc_rqst *rqstp, __be32 **p)
1210 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1211 struct xdr_buf integ_buf;
1212 struct xdr_netobj mic;
1213 u32 data_offset, mic_offset;
1218 integ_len = ntohl(*(*p)++);
1221 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1222 mic_offset = integ_len + data_offset;
1223 if (mic_offset > rcv_buf->len)
1225 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1228 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1229 mic_offset - data_offset))
1232 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1235 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1236 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1237 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1238 if (maj_stat != GSS_S_COMPLETE)
1244 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1245 struct rpc_rqst *rqstp, __be32 **p)
1247 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1253 opaque_len = ntohl(*(*p)++);
1254 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1255 if (offset + opaque_len > rcv_buf->len)
1257 /* remove padding: */
1258 rcv_buf->len = offset + opaque_len;
1260 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1261 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1262 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1263 if (maj_stat != GSS_S_COMPLETE)
1265 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1273 gss_unwrap_resp(struct rpc_task *task,
1274 kxdrproc_t decode, void *rqstp, __be32 *p, void *obj)
1276 struct rpc_cred *cred = task->tk_msg.rpc_cred;
1277 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1279 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1281 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1282 int savedlen = head->iov_len;
1285 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1287 switch (gss_cred->gc_service) {
1288 case RPC_GSS_SVC_NONE:
1290 case RPC_GSS_SVC_INTEGRITY:
1291 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1295 case RPC_GSS_SVC_PRIVACY:
1296 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1301 /* take into account extra slack for integrity and privacy cases: */
1302 cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
1303 + (savedlen - head->iov_len);
1305 status = decode(rqstp, p, obj);
1308 dprintk("RPC: %5u gss_unwrap_resp returning %d\n", task->tk_pid,
1313 static const struct rpc_authops authgss_ops = {
1314 .owner = THIS_MODULE,
1315 .au_flavor = RPC_AUTH_GSS,
1316 .au_name = "RPCSEC_GSS",
1317 .create = gss_create,
1318 .destroy = gss_destroy,
1319 .lookup_cred = gss_lookup_cred,
1320 .crcreate = gss_create_cred
1323 static const struct rpc_credops gss_credops = {
1324 .cr_name = "AUTH_GSS",
1325 .crdestroy = gss_destroy_cred,
1326 .cr_init = gss_cred_init,
1327 .crbind = rpcauth_generic_bind_cred,
1328 .crmatch = gss_match,
1329 .crmarshal = gss_marshal,
1330 .crrefresh = gss_refresh,
1331 .crvalidate = gss_validate,
1332 .crwrap_req = gss_wrap_req,
1333 .crunwrap_resp = gss_unwrap_resp,
1336 static const struct rpc_credops gss_nullops = {
1337 .cr_name = "AUTH_GSS",
1338 .crdestroy = gss_destroy_nullcred,
1339 .crbind = rpcauth_generic_bind_cred,
1340 .crmatch = gss_match,
1341 .crmarshal = gss_marshal,
1342 .crrefresh = gss_refresh_null,
1343 .crvalidate = gss_validate,
1344 .crwrap_req = gss_wrap_req,
1345 .crunwrap_resp = gss_unwrap_resp,
1348 static struct rpc_pipe_ops gss_upcall_ops = {
1349 .upcall = gss_pipe_upcall,
1350 .downcall = gss_pipe_downcall,
1351 .destroy_msg = gss_pipe_destroy_msg,
1352 .release_pipe = gss_pipe_release,
1356 * Initialize RPCSEC_GSS module
1358 static int __init init_rpcsec_gss(void)
1362 err = rpcauth_register(&authgss_ops);
1365 err = gss_svc_init();
1367 goto out_unregister;
1370 rpcauth_unregister(&authgss_ops);
1375 static void __exit exit_rpcsec_gss(void)
1378 rpcauth_unregister(&authgss_ops);
1381 MODULE_LICENSE("GPL");
1382 module_init(init_rpcsec_gss)
1383 module_exit(exit_rpcsec_gss)