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>
54 #include <linux/hashtable.h>
58 static const struct rpc_authops authgss_ops;
60 static const struct rpc_credops gss_credops;
61 static const struct rpc_credops gss_nullops;
63 #define GSS_RETRY_EXPIRED 5
64 static unsigned int gss_expired_cred_retry_delay = GSS_RETRY_EXPIRED;
66 #define GSS_KEY_EXPIRE_TIMEO 240
67 static unsigned int gss_key_expire_timeo = GSS_KEY_EXPIRE_TIMEO;
70 # define RPCDBG_FACILITY RPCDBG_AUTH
73 #define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
74 /* length of a krb5 verifier (48), plus data added before arguments when
75 * using integrity (two 4-byte integers): */
76 #define GSS_VERF_SLACK 100
78 static DEFINE_HASHTABLE(gss_auth_hash_table, 4);
79 static DEFINE_SPINLOCK(gss_auth_hash_lock);
82 struct rpc_pipe_dir_object pdo;
83 struct rpc_pipe *pipe;
84 struct rpc_clnt *clnt;
91 struct hlist_node hash;
92 struct rpc_auth rpc_auth;
93 struct gss_api_mech *mech;
94 enum rpc_gss_svc service;
95 struct rpc_clnt *client;
98 * There are two upcall pipes; dentry[1], named "gssd", is used
99 * for the new text-based upcall; dentry[0] is named after the
100 * mechanism (for example, "krb5") and exists for
101 * backwards-compatibility with older gssd's.
103 struct gss_pipe *gss_pipe[2];
104 const char *target_name;
107 /* pipe_version >= 0 if and only if someone has a pipe open. */
108 static DEFINE_SPINLOCK(pipe_version_lock);
109 static struct rpc_wait_queue pipe_version_rpc_waitqueue;
110 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue);
112 static void gss_free_ctx(struct gss_cl_ctx *);
113 static const struct rpc_pipe_ops gss_upcall_ops_v0;
114 static const struct rpc_pipe_ops gss_upcall_ops_v1;
116 static inline struct gss_cl_ctx *
117 gss_get_ctx(struct gss_cl_ctx *ctx)
119 atomic_inc(&ctx->count);
124 gss_put_ctx(struct gss_cl_ctx *ctx)
126 if (atomic_dec_and_test(&ctx->count))
131 * called by gss_upcall_callback and gss_create_upcall in order
132 * to set the gss context. The actual exchange of an old context
133 * and a new one is protected by the pipe->lock.
136 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
138 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
140 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
143 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
144 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
145 smp_mb__before_clear_bit();
146 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
150 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
152 const void *q = (const void *)((const char *)p + len);
153 if (unlikely(q > end || q < p))
154 return ERR_PTR(-EFAULT);
159 static inline const void *
160 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
165 p = simple_get_bytes(p, end, &len, sizeof(len));
168 q = (const void *)((const char *)p + len);
169 if (unlikely(q > end || q < p))
170 return ERR_PTR(-EFAULT);
171 dest->data = kmemdup(p, len, GFP_NOFS);
172 if (unlikely(dest->data == NULL))
173 return ERR_PTR(-ENOMEM);
178 static struct gss_cl_ctx *
179 gss_cred_get_ctx(struct rpc_cred *cred)
181 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
182 struct gss_cl_ctx *ctx = NULL;
185 if (gss_cred->gc_ctx)
186 ctx = gss_get_ctx(gss_cred->gc_ctx);
191 static struct gss_cl_ctx *
192 gss_alloc_context(void)
194 struct gss_cl_ctx *ctx;
196 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
198 ctx->gc_proc = RPC_GSS_PROC_DATA;
199 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
200 spin_lock_init(&ctx->gc_seq_lock);
201 atomic_set(&ctx->count,1);
206 #define GSSD_MIN_TIMEOUT (60 * 60)
208 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
212 unsigned int timeout;
213 unsigned long now = jiffies;
217 /* First unsigned int gives the remaining lifetime in seconds of the
218 * credential - e.g. the remaining TGT lifetime for Kerberos or
219 * the -t value passed to GSSD.
221 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
225 timeout = GSSD_MIN_TIMEOUT;
226 ctx->gc_expiry = now + ((unsigned long)timeout * HZ);
227 /* Sequence number window. Determines the maximum number of
228 * simultaneous requests
230 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
233 ctx->gc_win = window_size;
234 /* gssd signals an error by passing ctx->gc_win = 0: */
235 if (ctx->gc_win == 0) {
237 * in which case, p points to an error code. Anything other
238 * than -EKEYEXPIRED gets converted to -EACCES.
240 p = simple_get_bytes(p, end, &ret, sizeof(ret));
242 p = (ret == -EKEYEXPIRED) ? ERR_PTR(-EKEYEXPIRED) :
246 /* copy the opaque wire context */
247 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
250 /* import the opaque security context */
251 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
254 q = (const void *)((const char *)p + seclen);
255 if (unlikely(q > end || q < p)) {
256 p = ERR_PTR(-EFAULT);
259 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx, NULL, GFP_NOFS);
264 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u\n",
265 __func__, ctx->gc_expiry, now, timeout);
268 dprintk("RPC: %s returns error %ld\n", __func__, -PTR_ERR(p));
272 #define UPCALL_BUF_LEN 128
274 struct gss_upcall_msg {
277 struct rpc_pipe_msg msg;
278 struct list_head list;
279 struct gss_auth *auth;
280 struct rpc_pipe *pipe;
281 struct rpc_wait_queue rpc_waitqueue;
282 wait_queue_head_t waitqueue;
283 struct gss_cl_ctx *ctx;
284 char databuf[UPCALL_BUF_LEN];
287 static int get_pipe_version(struct net *net)
289 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
292 spin_lock(&pipe_version_lock);
293 if (sn->pipe_version >= 0) {
294 atomic_inc(&sn->pipe_users);
295 ret = sn->pipe_version;
298 spin_unlock(&pipe_version_lock);
302 static void put_pipe_version(struct net *net)
304 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
306 if (atomic_dec_and_lock(&sn->pipe_users, &pipe_version_lock)) {
307 sn->pipe_version = -1;
308 spin_unlock(&pipe_version_lock);
313 gss_release_msg(struct gss_upcall_msg *gss_msg)
315 struct net *net = gss_msg->auth->net;
316 if (!atomic_dec_and_test(&gss_msg->count))
318 put_pipe_version(net);
319 BUG_ON(!list_empty(&gss_msg->list));
320 if (gss_msg->ctx != NULL)
321 gss_put_ctx(gss_msg->ctx);
322 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
326 static struct gss_upcall_msg *
327 __gss_find_upcall(struct rpc_pipe *pipe, kuid_t uid)
329 struct gss_upcall_msg *pos;
330 list_for_each_entry(pos, &pipe->in_downcall, list) {
331 if (!uid_eq(pos->uid, uid))
333 atomic_inc(&pos->count);
334 dprintk("RPC: %s found msg %p\n", __func__, pos);
337 dprintk("RPC: %s found nothing\n", __func__);
341 /* Try to add an upcall to the pipefs queue.
342 * If an upcall owned by our uid already exists, then we return a reference
343 * to that upcall instead of adding the new upcall.
345 static inline struct gss_upcall_msg *
346 gss_add_msg(struct gss_upcall_msg *gss_msg)
348 struct rpc_pipe *pipe = gss_msg->pipe;
349 struct gss_upcall_msg *old;
351 spin_lock(&pipe->lock);
352 old = __gss_find_upcall(pipe, gss_msg->uid);
354 atomic_inc(&gss_msg->count);
355 list_add(&gss_msg->list, &pipe->in_downcall);
358 spin_unlock(&pipe->lock);
363 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
365 list_del_init(&gss_msg->list);
366 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
367 wake_up_all(&gss_msg->waitqueue);
368 atomic_dec(&gss_msg->count);
372 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
374 struct rpc_pipe *pipe = gss_msg->pipe;
376 if (list_empty(&gss_msg->list))
378 spin_lock(&pipe->lock);
379 if (!list_empty(&gss_msg->list))
380 __gss_unhash_msg(gss_msg);
381 spin_unlock(&pipe->lock);
385 gss_handle_downcall_result(struct gss_cred *gss_cred, struct gss_upcall_msg *gss_msg)
387 switch (gss_msg->msg.errno) {
389 if (gss_msg->ctx == NULL)
391 clear_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
392 gss_cred_set_ctx(&gss_cred->gc_base, gss_msg->ctx);
395 set_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
397 gss_cred->gc_upcall_timestamp = jiffies;
398 gss_cred->gc_upcall = NULL;
399 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
403 gss_upcall_callback(struct rpc_task *task)
405 struct gss_cred *gss_cred = container_of(task->tk_rqstp->rq_cred,
406 struct gss_cred, gc_base);
407 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
408 struct rpc_pipe *pipe = gss_msg->pipe;
410 spin_lock(&pipe->lock);
411 gss_handle_downcall_result(gss_cred, gss_msg);
412 spin_unlock(&pipe->lock);
413 task->tk_status = gss_msg->msg.errno;
414 gss_release_msg(gss_msg);
417 static void gss_encode_v0_msg(struct gss_upcall_msg *gss_msg)
419 uid_t uid = from_kuid(&init_user_ns, gss_msg->uid);
420 memcpy(gss_msg->databuf, &uid, sizeof(uid));
421 gss_msg->msg.data = gss_msg->databuf;
422 gss_msg->msg.len = sizeof(uid);
424 BUILD_BUG_ON(sizeof(uid) > sizeof(gss_msg->databuf));
427 static int gss_encode_v1_msg(struct gss_upcall_msg *gss_msg,
428 const char *service_name,
429 const char *target_name)
431 struct gss_api_mech *mech = gss_msg->auth->mech;
432 char *p = gss_msg->databuf;
433 size_t buflen = sizeof(gss_msg->databuf);
436 len = scnprintf(p, buflen, "mech=%s uid=%d ", mech->gm_name,
437 from_kuid(&init_user_ns, gss_msg->uid));
440 gss_msg->msg.len = len;
442 len = scnprintf(p, buflen, "target=%s ", target_name);
445 gss_msg->msg.len += len;
447 if (service_name != NULL) {
448 len = scnprintf(p, buflen, "service=%s ", service_name);
451 gss_msg->msg.len += len;
453 if (mech->gm_upcall_enctypes) {
454 len = scnprintf(p, buflen, "enctypes=%s ",
455 mech->gm_upcall_enctypes);
458 gss_msg->msg.len += len;
460 len = scnprintf(p, buflen, "\n");
463 gss_msg->msg.len += len;
465 gss_msg->msg.data = gss_msg->databuf;
472 static struct gss_upcall_msg *
473 gss_alloc_msg(struct gss_auth *gss_auth,
474 kuid_t uid, const char *service_name)
476 struct gss_upcall_msg *gss_msg;
480 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
483 vers = get_pipe_version(gss_auth->net);
487 gss_msg->pipe = gss_auth->gss_pipe[vers]->pipe;
488 INIT_LIST_HEAD(&gss_msg->list);
489 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
490 init_waitqueue_head(&gss_msg->waitqueue);
491 atomic_set(&gss_msg->count, 1);
493 gss_msg->auth = gss_auth;
496 gss_encode_v0_msg(gss_msg);
499 err = gss_encode_v1_msg(gss_msg, service_name, gss_auth->target_name);
510 static struct gss_upcall_msg *
511 gss_setup_upcall(struct gss_auth *gss_auth, struct rpc_cred *cred)
513 struct gss_cred *gss_cred = container_of(cred,
514 struct gss_cred, gc_base);
515 struct gss_upcall_msg *gss_new, *gss_msg;
516 kuid_t uid = cred->cr_uid;
518 gss_new = gss_alloc_msg(gss_auth, uid, gss_cred->gc_principal);
521 gss_msg = gss_add_msg(gss_new);
522 if (gss_msg == gss_new) {
523 int res = rpc_queue_upcall(gss_new->pipe, &gss_new->msg);
525 gss_unhash_msg(gss_new);
526 gss_msg = ERR_PTR(res);
529 gss_release_msg(gss_new);
533 static void warn_gssd(void)
535 static unsigned long ratelimit;
536 unsigned long now = jiffies;
538 if (time_after(now, ratelimit)) {
539 pr_warn("RPC: AUTH_GSS upcall failed. Please check user daemon is running.\n");
540 ratelimit = now + 15*HZ;
545 gss_refresh_upcall(struct rpc_task *task)
547 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
548 struct gss_auth *gss_auth = container_of(cred->cr_auth,
549 struct gss_auth, rpc_auth);
550 struct gss_cred *gss_cred = container_of(cred,
551 struct gss_cred, gc_base);
552 struct gss_upcall_msg *gss_msg;
553 struct rpc_pipe *pipe;
556 dprintk("RPC: %5u %s for uid %u\n",
557 task->tk_pid, __func__, from_kuid(&init_user_ns, cred->cr_uid));
558 gss_msg = gss_setup_upcall(gss_auth, cred);
559 if (PTR_ERR(gss_msg) == -EAGAIN) {
560 /* XXX: warning on the first, under the assumption we
561 * shouldn't normally hit this case on a refresh. */
563 task->tk_timeout = 15*HZ;
564 rpc_sleep_on(&pipe_version_rpc_waitqueue, task, NULL);
567 if (IS_ERR(gss_msg)) {
568 err = PTR_ERR(gss_msg);
571 pipe = gss_msg->pipe;
572 spin_lock(&pipe->lock);
573 if (gss_cred->gc_upcall != NULL)
574 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
575 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
576 task->tk_timeout = 0;
577 gss_cred->gc_upcall = gss_msg;
578 /* gss_upcall_callback will release the reference to gss_upcall_msg */
579 atomic_inc(&gss_msg->count);
580 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
582 gss_handle_downcall_result(gss_cred, gss_msg);
583 err = gss_msg->msg.errno;
585 spin_unlock(&pipe->lock);
586 gss_release_msg(gss_msg);
588 dprintk("RPC: %5u %s for uid %u result %d\n",
589 task->tk_pid, __func__,
590 from_kuid(&init_user_ns, cred->cr_uid), err);
595 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
597 struct net *net = gss_auth->net;
598 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
599 struct rpc_pipe *pipe;
600 struct rpc_cred *cred = &gss_cred->gc_base;
601 struct gss_upcall_msg *gss_msg;
605 dprintk("RPC: %s for uid %u\n",
606 __func__, from_kuid(&init_user_ns, cred->cr_uid));
609 /* if gssd is down, just skip upcalling altogether */
610 if (!gssd_running(net)) {
614 gss_msg = gss_setup_upcall(gss_auth, cred);
615 if (PTR_ERR(gss_msg) == -EAGAIN) {
616 err = wait_event_interruptible_timeout(pipe_version_waitqueue,
617 sn->pipe_version >= 0, 15 * HZ);
618 if (sn->pipe_version < 0) {
626 if (IS_ERR(gss_msg)) {
627 err = PTR_ERR(gss_msg);
630 pipe = gss_msg->pipe;
632 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_KILLABLE);
633 spin_lock(&pipe->lock);
634 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
637 spin_unlock(&pipe->lock);
638 if (fatal_signal_pending(current)) {
645 gss_cred_set_ctx(cred, gss_msg->ctx);
647 err = gss_msg->msg.errno;
648 spin_unlock(&pipe->lock);
650 finish_wait(&gss_msg->waitqueue, &wait);
651 gss_release_msg(gss_msg);
653 dprintk("RPC: %s for uid %u result %d\n",
654 __func__, from_kuid(&init_user_ns, cred->cr_uid), err);
658 #define MSG_BUF_MAXSIZE 1024
661 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
665 struct gss_upcall_msg *gss_msg;
666 struct rpc_pipe *pipe = RPC_I(file_inode(filp))->pipe;
667 struct gss_cl_ctx *ctx;
670 ssize_t err = -EFBIG;
672 if (mlen > MSG_BUF_MAXSIZE)
675 buf = kmalloc(mlen, GFP_NOFS);
680 if (copy_from_user(buf, src, mlen))
683 end = (const void *)((char *)buf + mlen);
684 p = simple_get_bytes(buf, end, &id, sizeof(id));
690 uid = make_kuid(&init_user_ns, id);
691 if (!uid_valid(uid)) {
697 ctx = gss_alloc_context();
702 /* Find a matching upcall */
703 spin_lock(&pipe->lock);
704 gss_msg = __gss_find_upcall(pipe, uid);
705 if (gss_msg == NULL) {
706 spin_unlock(&pipe->lock);
709 list_del_init(&gss_msg->list);
710 spin_unlock(&pipe->lock);
712 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
718 gss_msg->msg.errno = err;
725 gss_msg->msg.errno = -EAGAIN;
728 printk(KERN_CRIT "%s: bad return from "
729 "gss_fill_context: %zd\n", __func__, err);
732 goto err_release_msg;
734 gss_msg->ctx = gss_get_ctx(ctx);
738 spin_lock(&pipe->lock);
739 __gss_unhash_msg(gss_msg);
740 spin_unlock(&pipe->lock);
741 gss_release_msg(gss_msg);
747 dprintk("RPC: %s returning %Zd\n", __func__, err);
751 static int gss_pipe_open(struct inode *inode, int new_version)
753 struct net *net = inode->i_sb->s_fs_info;
754 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
757 spin_lock(&pipe_version_lock);
758 if (sn->pipe_version < 0) {
759 /* First open of any gss pipe determines the version: */
760 sn->pipe_version = new_version;
761 rpc_wake_up(&pipe_version_rpc_waitqueue);
762 wake_up(&pipe_version_waitqueue);
763 } else if (sn->pipe_version != new_version) {
764 /* Trying to open a pipe of a different version */
768 atomic_inc(&sn->pipe_users);
770 spin_unlock(&pipe_version_lock);
775 static int gss_pipe_open_v0(struct inode *inode)
777 return gss_pipe_open(inode, 0);
780 static int gss_pipe_open_v1(struct inode *inode)
782 return gss_pipe_open(inode, 1);
786 gss_pipe_release(struct inode *inode)
788 struct net *net = inode->i_sb->s_fs_info;
789 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
790 struct gss_upcall_msg *gss_msg;
793 spin_lock(&pipe->lock);
794 list_for_each_entry(gss_msg, &pipe->in_downcall, list) {
796 if (!list_empty(&gss_msg->msg.list))
798 gss_msg->msg.errno = -EPIPE;
799 atomic_inc(&gss_msg->count);
800 __gss_unhash_msg(gss_msg);
801 spin_unlock(&pipe->lock);
802 gss_release_msg(gss_msg);
805 spin_unlock(&pipe->lock);
807 put_pipe_version(net);
811 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
813 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
815 if (msg->errno < 0) {
816 dprintk("RPC: %s releasing msg %p\n",
818 atomic_inc(&gss_msg->count);
819 gss_unhash_msg(gss_msg);
820 if (msg->errno == -ETIMEDOUT)
822 gss_release_msg(gss_msg);
826 static void gss_pipe_dentry_destroy(struct dentry *dir,
827 struct rpc_pipe_dir_object *pdo)
829 struct gss_pipe *gss_pipe = pdo->pdo_data;
830 struct rpc_pipe *pipe = gss_pipe->pipe;
832 if (pipe->dentry != NULL) {
833 rpc_unlink(pipe->dentry);
838 static int gss_pipe_dentry_create(struct dentry *dir,
839 struct rpc_pipe_dir_object *pdo)
841 struct gss_pipe *p = pdo->pdo_data;
842 struct dentry *dentry;
844 dentry = rpc_mkpipe_dentry(dir, p->name, p->clnt, p->pipe);
846 return PTR_ERR(dentry);
847 p->pipe->dentry = dentry;
851 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops = {
852 .create = gss_pipe_dentry_create,
853 .destroy = gss_pipe_dentry_destroy,
856 static struct gss_pipe *gss_pipe_alloc(struct rpc_clnt *clnt,
858 const struct rpc_pipe_ops *upcall_ops)
863 p = kmalloc(sizeof(*p), GFP_KERNEL);
866 p->pipe = rpc_mkpipe_data(upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
867 if (IS_ERR(p->pipe)) {
868 err = PTR_ERR(p->pipe);
869 goto err_free_gss_pipe;
874 rpc_init_pipe_dir_object(&p->pdo,
875 &gss_pipe_dir_object_ops,
884 struct gss_alloc_pdo {
885 struct rpc_clnt *clnt;
887 const struct rpc_pipe_ops *upcall_ops;
890 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object *pdo, void *data)
892 struct gss_pipe *gss_pipe;
893 struct gss_alloc_pdo *args = data;
895 if (pdo->pdo_ops != &gss_pipe_dir_object_ops)
897 gss_pipe = container_of(pdo, struct gss_pipe, pdo);
898 if (strcmp(gss_pipe->name, args->name) != 0)
900 if (!kref_get_unless_zero(&gss_pipe->kref))
905 static struct rpc_pipe_dir_object *gss_pipe_alloc_pdo(void *data)
907 struct gss_pipe *gss_pipe;
908 struct gss_alloc_pdo *args = data;
910 gss_pipe = gss_pipe_alloc(args->clnt, args->name, args->upcall_ops);
911 if (!IS_ERR(gss_pipe))
912 return &gss_pipe->pdo;
916 static struct gss_pipe *gss_pipe_get(struct rpc_clnt *clnt,
918 const struct rpc_pipe_ops *upcall_ops)
920 struct net *net = rpc_net_ns(clnt);
921 struct rpc_pipe_dir_object *pdo;
922 struct gss_alloc_pdo args = {
925 .upcall_ops = upcall_ops,
928 pdo = rpc_find_or_alloc_pipe_dir_object(net,
929 &clnt->cl_pipedir_objects,
934 return container_of(pdo, struct gss_pipe, pdo);
935 return ERR_PTR(-ENOMEM);
938 static void __gss_pipe_free(struct gss_pipe *p)
940 struct rpc_clnt *clnt = p->clnt;
941 struct net *net = rpc_net_ns(clnt);
943 rpc_remove_pipe_dir_object(net,
944 &clnt->cl_pipedir_objects,
946 rpc_destroy_pipe_data(p->pipe);
950 static void __gss_pipe_release(struct kref *kref)
952 struct gss_pipe *p = container_of(kref, struct gss_pipe, kref);
957 static void gss_pipe_free(struct gss_pipe *p)
960 kref_put(&p->kref, __gss_pipe_release);
964 * NOTE: we have the opportunity to use different
965 * parameters based on the input flavor (which must be a pseudoflavor)
967 static struct gss_auth *
968 gss_create_new(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
970 rpc_authflavor_t flavor = args->pseudoflavor;
971 struct gss_auth *gss_auth;
972 struct gss_pipe *gss_pipe;
973 struct rpc_auth * auth;
974 int err = -ENOMEM; /* XXX? */
976 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
978 if (!try_module_get(THIS_MODULE))
980 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
982 INIT_HLIST_NODE(&gss_auth->hash);
983 gss_auth->target_name = NULL;
984 if (args->target_name) {
985 gss_auth->target_name = kstrdup(args->target_name, GFP_KERNEL);
986 if (gss_auth->target_name == NULL)
989 gss_auth->client = clnt;
990 gss_auth->net = get_net(rpc_net_ns(clnt));
992 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
993 if (!gss_auth->mech) {
994 dprintk("RPC: Pseudoflavor %d not found!\n", flavor);
997 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
998 if (gss_auth->service == 0)
1000 auth = &gss_auth->rpc_auth;
1001 auth->au_cslack = GSS_CRED_SLACK >> 2;
1002 auth->au_rslack = GSS_VERF_SLACK >> 2;
1003 auth->au_ops = &authgss_ops;
1004 auth->au_flavor = flavor;
1005 atomic_set(&auth->au_count, 1);
1006 kref_init(&gss_auth->kref);
1008 err = rpcauth_init_credcache(auth);
1012 * Note: if we created the old pipe first, then someone who
1013 * examined the directory at the right moment might conclude
1014 * that we supported only the old pipe. So we instead create
1015 * the new pipe first.
1017 gss_pipe = gss_pipe_get(clnt, "gssd", &gss_upcall_ops_v1);
1018 if (IS_ERR(gss_pipe)) {
1019 err = PTR_ERR(gss_pipe);
1020 goto err_destroy_credcache;
1022 gss_auth->gss_pipe[1] = gss_pipe;
1024 gss_pipe = gss_pipe_get(clnt, gss_auth->mech->gm_name,
1025 &gss_upcall_ops_v0);
1026 if (IS_ERR(gss_pipe)) {
1027 err = PTR_ERR(gss_pipe);
1028 goto err_destroy_pipe_1;
1030 gss_auth->gss_pipe[0] = gss_pipe;
1034 gss_pipe_free(gss_auth->gss_pipe[1]);
1035 err_destroy_credcache:
1036 rpcauth_destroy_credcache(auth);
1038 gss_mech_put(gss_auth->mech);
1040 put_net(gss_auth->net);
1042 kfree(gss_auth->target_name);
1045 module_put(THIS_MODULE);
1046 return ERR_PTR(err);
1050 gss_free(struct gss_auth *gss_auth)
1052 gss_pipe_free(gss_auth->gss_pipe[0]);
1053 gss_pipe_free(gss_auth->gss_pipe[1]);
1054 gss_mech_put(gss_auth->mech);
1055 put_net(gss_auth->net);
1056 kfree(gss_auth->target_name);
1059 module_put(THIS_MODULE);
1063 gss_free_callback(struct kref *kref)
1065 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
1071 gss_destroy(struct rpc_auth *auth)
1073 struct gss_auth *gss_auth = container_of(auth,
1074 struct gss_auth, rpc_auth);
1076 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1077 auth, auth->au_flavor);
1079 if (hash_hashed(&gss_auth->hash)) {
1080 spin_lock(&gss_auth_hash_lock);
1081 hash_del(&gss_auth->hash);
1082 spin_unlock(&gss_auth_hash_lock);
1085 gss_pipe_free(gss_auth->gss_pipe[0]);
1086 gss_auth->gss_pipe[0] = NULL;
1087 gss_pipe_free(gss_auth->gss_pipe[1]);
1088 gss_auth->gss_pipe[1] = NULL;
1089 rpcauth_destroy_credcache(auth);
1091 kref_put(&gss_auth->kref, gss_free_callback);
1095 * Auths may be shared between rpc clients that were cloned from a
1096 * common client with the same xprt, if they also share the flavor and
1099 * The auth is looked up from the oldest parent sharing the same
1100 * cl_xprt, and the auth itself references only that common parent
1101 * (which is guaranteed to last as long as any of its descendants).
1103 static struct gss_auth *
1104 gss_auth_find_or_add_hashed(struct rpc_auth_create_args *args,
1105 struct rpc_clnt *clnt,
1106 struct gss_auth *new)
1108 struct gss_auth *gss_auth;
1109 unsigned long hashval = (unsigned long)clnt;
1111 spin_lock(&gss_auth_hash_lock);
1112 hash_for_each_possible(gss_auth_hash_table,
1116 if (gss_auth->client != clnt)
1118 if (gss_auth->rpc_auth.au_flavor != args->pseudoflavor)
1120 if (gss_auth->target_name != args->target_name) {
1121 if (gss_auth->target_name == NULL)
1123 if (args->target_name == NULL)
1125 if (strcmp(gss_auth->target_name, args->target_name))
1128 if (!atomic_inc_not_zero(&gss_auth->rpc_auth.au_count))
1133 hash_add(gss_auth_hash_table, &new->hash, hashval);
1136 spin_unlock(&gss_auth_hash_lock);
1140 static struct gss_auth *
1141 gss_create_hashed(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1143 struct gss_auth *gss_auth;
1144 struct gss_auth *new;
1146 gss_auth = gss_auth_find_or_add_hashed(args, clnt, NULL);
1147 if (gss_auth != NULL)
1149 new = gss_create_new(args, clnt);
1152 gss_auth = gss_auth_find_or_add_hashed(args, clnt, new);
1153 if (gss_auth != new)
1154 gss_destroy(&new->rpc_auth);
1159 static struct rpc_auth *
1160 gss_create(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1162 struct gss_auth *gss_auth;
1163 struct rpc_xprt *xprt = rcu_access_pointer(clnt->cl_xprt);
1165 while (clnt != clnt->cl_parent) {
1166 struct rpc_clnt *parent = clnt->cl_parent;
1167 /* Find the original parent for this transport */
1168 if (rcu_access_pointer(parent->cl_xprt) != xprt)
1173 gss_auth = gss_create_hashed(args, clnt);
1174 if (IS_ERR(gss_auth))
1175 return ERR_CAST(gss_auth);
1176 return &gss_auth->rpc_auth;
1180 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1181 * to the server with the GSS control procedure field set to
1182 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1183 * all RPCSEC_GSS state associated with that context.
1186 gss_destroying_context(struct rpc_cred *cred)
1188 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1189 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1190 struct rpc_task *task;
1192 if (gss_cred->gc_ctx == NULL ||
1193 test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
1196 gss_cred->gc_ctx->gc_proc = RPC_GSS_PROC_DESTROY;
1197 cred->cr_ops = &gss_nullops;
1199 /* Take a reference to ensure the cred will be destroyed either
1200 * by the RPC call or by the put_rpccred() below */
1203 task = rpc_call_null(gss_auth->client, cred, RPC_TASK_ASYNC|RPC_TASK_SOFT);
1211 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1212 * to create a new cred or context, so they check that things have been
1213 * allocated before freeing them. */
1215 gss_do_free_ctx(struct gss_cl_ctx *ctx)
1217 dprintk("RPC: %s\n", __func__);
1219 gss_delete_sec_context(&ctx->gc_gss_ctx);
1220 kfree(ctx->gc_wire_ctx.data);
1225 gss_free_ctx_callback(struct rcu_head *head)
1227 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
1228 gss_do_free_ctx(ctx);
1232 gss_free_ctx(struct gss_cl_ctx *ctx)
1234 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
1238 gss_free_cred(struct gss_cred *gss_cred)
1240 dprintk("RPC: %s cred=%p\n", __func__, gss_cred);
1245 gss_free_cred_callback(struct rcu_head *head)
1247 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
1248 gss_free_cred(gss_cred);
1252 gss_destroy_nullcred(struct rpc_cred *cred)
1254 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1255 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1256 struct gss_cl_ctx *ctx = gss_cred->gc_ctx;
1258 RCU_INIT_POINTER(gss_cred->gc_ctx, NULL);
1259 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
1262 kref_put(&gss_auth->kref, gss_free_callback);
1266 gss_destroy_cred(struct rpc_cred *cred)
1269 if (gss_destroying_context(cred))
1271 gss_destroy_nullcred(cred);
1275 * Lookup RPCSEC_GSS cred for the current process
1277 static struct rpc_cred *
1278 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1280 return rpcauth_lookup_credcache(auth, acred, flags);
1283 static struct rpc_cred *
1284 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1286 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1287 struct gss_cred *cred = NULL;
1290 dprintk("RPC: %s for uid %d, flavor %d\n",
1291 __func__, from_kuid(&init_user_ns, acred->uid),
1294 if (!(cred = kzalloc(sizeof(*cred), GFP_NOFS)))
1297 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
1299 * Note: in order to force a call to call_refresh(), we deliberately
1300 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1302 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
1303 cred->gc_service = gss_auth->service;
1304 cred->gc_principal = NULL;
1305 if (acred->machine_cred)
1306 cred->gc_principal = acred->principal;
1307 kref_get(&gss_auth->kref);
1308 return &cred->gc_base;
1311 dprintk("RPC: %s failed with error %d\n", __func__, err);
1312 return ERR_PTR(err);
1316 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
1318 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1319 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
1323 err = gss_create_upcall(gss_auth, gss_cred);
1324 } while (err == -EAGAIN);
1329 * Returns -EACCES if GSS context is NULL or will expire within the
1330 * timeout (miliseconds)
1333 gss_key_timeout(struct rpc_cred *rc)
1335 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1336 unsigned long now = jiffies;
1337 unsigned long expire;
1339 if (gss_cred->gc_ctx == NULL)
1342 expire = gss_cred->gc_ctx->gc_expiry - (gss_key_expire_timeo * HZ);
1344 if (time_after(now, expire))
1350 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
1352 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1355 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
1357 /* Don't match with creds that have expired. */
1358 if (time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
1360 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
1363 if (acred->principal != NULL) {
1364 if (gss_cred->gc_principal == NULL)
1366 ret = strcmp(acred->principal, gss_cred->gc_principal) == 0;
1369 if (gss_cred->gc_principal != NULL)
1371 ret = uid_eq(rc->cr_uid, acred->uid);
1377 /* Notify acred users of GSS context expiration timeout */
1378 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags) &&
1379 (gss_key_timeout(rc) != 0)) {
1380 /* test will now be done from generic cred */
1381 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags);
1382 /* tell NFS layer that key will expire soon */
1383 set_bit(RPC_CRED_KEY_EXPIRE_SOON, &acred->ac_flags);
1389 * Marshal credentials.
1390 * Maybe we should keep a cached credential for performance reasons.
1393 gss_marshal(struct rpc_task *task, __be32 *p)
1395 struct rpc_rqst *req = task->tk_rqstp;
1396 struct rpc_cred *cred = req->rq_cred;
1397 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1399 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1402 struct xdr_netobj mic;
1404 struct xdr_buf verf_buf;
1406 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1408 *p++ = htonl(RPC_AUTH_GSS);
1411 spin_lock(&ctx->gc_seq_lock);
1412 req->rq_seqno = ctx->gc_seq++;
1413 spin_unlock(&ctx->gc_seq_lock);
1415 *p++ = htonl((u32) RPC_GSS_VERSION);
1416 *p++ = htonl((u32) ctx->gc_proc);
1417 *p++ = htonl((u32) req->rq_seqno);
1418 *p++ = htonl((u32) gss_cred->gc_service);
1419 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
1420 *cred_len = htonl((p - (cred_len + 1)) << 2);
1422 /* We compute the checksum for the verifier over the xdr-encoded bytes
1423 * starting with the xid and ending at the end of the credential: */
1424 iov.iov_base = xprt_skip_transport_header(req->rq_xprt,
1425 req->rq_snd_buf.head[0].iov_base);
1426 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
1427 xdr_buf_from_iov(&iov, &verf_buf);
1429 /* set verifier flavor*/
1430 *p++ = htonl(RPC_AUTH_GSS);
1432 mic.data = (u8 *)(p + 1);
1433 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1434 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
1435 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1436 } else if (maj_stat != 0) {
1437 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
1440 p = xdr_encode_opaque(p, NULL, mic.len);
1448 static int gss_renew_cred(struct rpc_task *task)
1450 struct rpc_cred *oldcred = task->tk_rqstp->rq_cred;
1451 struct gss_cred *gss_cred = container_of(oldcred,
1454 struct rpc_auth *auth = oldcred->cr_auth;
1455 struct auth_cred acred = {
1456 .uid = oldcred->cr_uid,
1457 .principal = gss_cred->gc_principal,
1458 .machine_cred = (gss_cred->gc_principal != NULL ? 1 : 0),
1460 struct rpc_cred *new;
1462 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
1464 return PTR_ERR(new);
1465 task->tk_rqstp->rq_cred = new;
1466 put_rpccred(oldcred);
1470 static int gss_cred_is_negative_entry(struct rpc_cred *cred)
1472 if (test_bit(RPCAUTH_CRED_NEGATIVE, &cred->cr_flags)) {
1473 unsigned long now = jiffies;
1474 unsigned long begin, expire;
1475 struct gss_cred *gss_cred;
1477 gss_cred = container_of(cred, struct gss_cred, gc_base);
1478 begin = gss_cred->gc_upcall_timestamp;
1479 expire = begin + gss_expired_cred_retry_delay * HZ;
1481 if (time_in_range_open(now, begin, expire))
1488 * Refresh credentials. XXX - finish
1491 gss_refresh(struct rpc_task *task)
1493 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1496 if (gss_cred_is_negative_entry(cred))
1497 return -EKEYEXPIRED;
1499 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
1500 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
1501 ret = gss_renew_cred(task);
1504 cred = task->tk_rqstp->rq_cred;
1507 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
1508 ret = gss_refresh_upcall(task);
1513 /* Dummy refresh routine: used only when destroying the context */
1515 gss_refresh_null(struct rpc_task *task)
1521 gss_validate(struct rpc_task *task, __be32 *p)
1523 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1524 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1527 struct xdr_buf verf_buf;
1528 struct xdr_netobj mic;
1531 __be32 *ret = ERR_PTR(-EIO);
1533 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1536 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
1538 if (flav != RPC_AUTH_GSS)
1540 seq = htonl(task->tk_rqstp->rq_seqno);
1541 iov.iov_base = &seq;
1542 iov.iov_len = sizeof(seq);
1543 xdr_buf_from_iov(&iov, &verf_buf);
1547 ret = ERR_PTR(-EACCES);
1548 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1549 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1550 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1552 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1553 task->tk_pid, __func__, maj_stat);
1556 /* We leave it to unwrap to calculate au_rslack. For now we just
1557 * calculate the length of the verifier: */
1558 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1560 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1561 task->tk_pid, __func__);
1562 return p + XDR_QUADLEN(len);
1565 dprintk("RPC: %5u %s failed ret %ld.\n", task->tk_pid, __func__,
1570 static void gss_wrap_req_encode(kxdreproc_t encode, struct rpc_rqst *rqstp,
1571 __be32 *p, void *obj)
1573 struct xdr_stream xdr;
1575 xdr_init_encode(&xdr, &rqstp->rq_snd_buf, p);
1576 encode(rqstp, &xdr, obj);
1580 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1581 kxdreproc_t encode, struct rpc_rqst *rqstp,
1582 __be32 *p, void *obj)
1584 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1585 struct xdr_buf integ_buf;
1586 __be32 *integ_len = NULL;
1587 struct xdr_netobj mic;
1595 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1596 *p++ = htonl(rqstp->rq_seqno);
1598 gss_wrap_req_encode(encode, rqstp, p, obj);
1600 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1601 offset, snd_buf->len - offset))
1603 *integ_len = htonl(integ_buf.len);
1605 /* guess whether we're in the head or the tail: */
1606 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1607 iov = snd_buf->tail;
1609 iov = snd_buf->head;
1610 p = iov->iov_base + iov->iov_len;
1611 mic.data = (u8 *)(p + 1);
1613 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1614 status = -EIO; /* XXX? */
1615 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1616 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1619 q = xdr_encode_opaque(p, NULL, mic.len);
1621 offset = (u8 *)q - (u8 *)p;
1622 iov->iov_len += offset;
1623 snd_buf->len += offset;
1628 priv_release_snd_buf(struct rpc_rqst *rqstp)
1632 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1633 __free_page(rqstp->rq_enc_pages[i]);
1634 kfree(rqstp->rq_enc_pages);
1638 alloc_enc_pages(struct rpc_rqst *rqstp)
1640 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1643 if (snd_buf->page_len == 0) {
1644 rqstp->rq_enc_pages_num = 0;
1648 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1649 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
1650 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1652 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1654 if (!rqstp->rq_enc_pages)
1656 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1657 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1658 if (rqstp->rq_enc_pages[i] == NULL)
1661 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1664 rqstp->rq_enc_pages_num = i;
1665 priv_release_snd_buf(rqstp);
1671 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1672 kxdreproc_t encode, struct rpc_rqst *rqstp,
1673 __be32 *p, void *obj)
1675 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1680 struct page **inpages;
1687 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1688 *p++ = htonl(rqstp->rq_seqno);
1690 gss_wrap_req_encode(encode, rqstp, p, obj);
1692 status = alloc_enc_pages(rqstp);
1695 first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
1696 inpages = snd_buf->pages + first;
1697 snd_buf->pages = rqstp->rq_enc_pages;
1698 snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
1700 * Give the tail its own page, in case we need extra space in the
1701 * head when wrapping:
1703 * call_allocate() allocates twice the slack space required
1704 * by the authentication flavor to rq_callsize.
1705 * For GSS, slack is GSS_CRED_SLACK.
1707 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1708 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1709 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1710 snd_buf->tail[0].iov_base = tmp;
1712 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1713 /* slack space should prevent this ever happening: */
1714 BUG_ON(snd_buf->len > snd_buf->buflen);
1716 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1717 * done anyway, so it's safe to put the request on the wire: */
1718 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1719 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1723 *opaque_len = htonl(snd_buf->len - offset);
1724 /* guess whether we're in the head or the tail: */
1725 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1726 iov = snd_buf->tail;
1728 iov = snd_buf->head;
1729 p = iov->iov_base + iov->iov_len;
1730 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1732 iov->iov_len += pad;
1733 snd_buf->len += pad;
1739 gss_wrap_req(struct rpc_task *task,
1740 kxdreproc_t encode, void *rqstp, __be32 *p, void *obj)
1742 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1743 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1745 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1748 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1749 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1750 /* The spec seems a little ambiguous here, but I think that not
1751 * wrapping context destruction requests makes the most sense.
1753 gss_wrap_req_encode(encode, rqstp, p, obj);
1757 switch (gss_cred->gc_service) {
1758 case RPC_GSS_SVC_NONE:
1759 gss_wrap_req_encode(encode, rqstp, p, obj);
1762 case RPC_GSS_SVC_INTEGRITY:
1763 status = gss_wrap_req_integ(cred, ctx, encode, rqstp, p, obj);
1765 case RPC_GSS_SVC_PRIVACY:
1766 status = gss_wrap_req_priv(cred, ctx, encode, rqstp, p, obj);
1771 dprintk("RPC: %5u %s returning %d\n", task->tk_pid, __func__, status);
1776 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1777 struct rpc_rqst *rqstp, __be32 **p)
1779 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1780 struct xdr_buf integ_buf;
1781 struct xdr_netobj mic;
1782 u32 data_offset, mic_offset;
1787 integ_len = ntohl(*(*p)++);
1790 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1791 mic_offset = integ_len + data_offset;
1792 if (mic_offset > rcv_buf->len)
1794 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1797 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1798 mic_offset - data_offset))
1801 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1804 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1805 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1806 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1807 if (maj_stat != GSS_S_COMPLETE)
1813 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1814 struct rpc_rqst *rqstp, __be32 **p)
1816 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1822 opaque_len = ntohl(*(*p)++);
1823 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1824 if (offset + opaque_len > rcv_buf->len)
1826 /* remove padding: */
1827 rcv_buf->len = offset + opaque_len;
1829 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1830 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1831 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1832 if (maj_stat != GSS_S_COMPLETE)
1834 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1841 gss_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
1842 __be32 *p, void *obj)
1844 struct xdr_stream xdr;
1846 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
1847 return decode(rqstp, &xdr, obj);
1851 gss_unwrap_resp(struct rpc_task *task,
1852 kxdrdproc_t decode, void *rqstp, __be32 *p, void *obj)
1854 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1855 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1857 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1859 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1860 int savedlen = head->iov_len;
1863 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1865 switch (gss_cred->gc_service) {
1866 case RPC_GSS_SVC_NONE:
1868 case RPC_GSS_SVC_INTEGRITY:
1869 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1873 case RPC_GSS_SVC_PRIVACY:
1874 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1879 /* take into account extra slack for integrity and privacy cases: */
1880 cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
1881 + (savedlen - head->iov_len);
1883 status = gss_unwrap_req_decode(decode, rqstp, p, obj);
1886 dprintk("RPC: %5u %s returning %d\n",
1887 task->tk_pid, __func__, status);
1891 static const struct rpc_authops authgss_ops = {
1892 .owner = THIS_MODULE,
1893 .au_flavor = RPC_AUTH_GSS,
1894 .au_name = "RPCSEC_GSS",
1895 .create = gss_create,
1896 .destroy = gss_destroy,
1897 .lookup_cred = gss_lookup_cred,
1898 .crcreate = gss_create_cred,
1899 .list_pseudoflavors = gss_mech_list_pseudoflavors,
1900 .info2flavor = gss_mech_info2flavor,
1901 .flavor2info = gss_mech_flavor2info,
1904 static const struct rpc_credops gss_credops = {
1905 .cr_name = "AUTH_GSS",
1906 .crdestroy = gss_destroy_cred,
1907 .cr_init = gss_cred_init,
1908 .crbind = rpcauth_generic_bind_cred,
1909 .crmatch = gss_match,
1910 .crmarshal = gss_marshal,
1911 .crrefresh = gss_refresh,
1912 .crvalidate = gss_validate,
1913 .crwrap_req = gss_wrap_req,
1914 .crunwrap_resp = gss_unwrap_resp,
1915 .crkey_timeout = gss_key_timeout,
1918 static const struct rpc_credops gss_nullops = {
1919 .cr_name = "AUTH_GSS",
1920 .crdestroy = gss_destroy_nullcred,
1921 .crbind = rpcauth_generic_bind_cred,
1922 .crmatch = gss_match,
1923 .crmarshal = gss_marshal,
1924 .crrefresh = gss_refresh_null,
1925 .crvalidate = gss_validate,
1926 .crwrap_req = gss_wrap_req,
1927 .crunwrap_resp = gss_unwrap_resp,
1930 static const struct rpc_pipe_ops gss_upcall_ops_v0 = {
1931 .upcall = rpc_pipe_generic_upcall,
1932 .downcall = gss_pipe_downcall,
1933 .destroy_msg = gss_pipe_destroy_msg,
1934 .open_pipe = gss_pipe_open_v0,
1935 .release_pipe = gss_pipe_release,
1938 static const struct rpc_pipe_ops gss_upcall_ops_v1 = {
1939 .upcall = rpc_pipe_generic_upcall,
1940 .downcall = gss_pipe_downcall,
1941 .destroy_msg = gss_pipe_destroy_msg,
1942 .open_pipe = gss_pipe_open_v1,
1943 .release_pipe = gss_pipe_release,
1946 static __net_init int rpcsec_gss_init_net(struct net *net)
1948 return gss_svc_init_net(net);
1951 static __net_exit void rpcsec_gss_exit_net(struct net *net)
1953 gss_svc_shutdown_net(net);
1956 static struct pernet_operations rpcsec_gss_net_ops = {
1957 .init = rpcsec_gss_init_net,
1958 .exit = rpcsec_gss_exit_net,
1962 * Initialize RPCSEC_GSS module
1964 static int __init init_rpcsec_gss(void)
1968 err = rpcauth_register(&authgss_ops);
1971 err = gss_svc_init();
1973 goto out_unregister;
1974 err = register_pernet_subsys(&rpcsec_gss_net_ops);
1977 rpc_init_wait_queue(&pipe_version_rpc_waitqueue, "gss pipe version");
1982 rpcauth_unregister(&authgss_ops);
1987 static void __exit exit_rpcsec_gss(void)
1989 unregister_pernet_subsys(&rpcsec_gss_net_ops);
1991 rpcauth_unregister(&authgss_ops);
1992 rcu_barrier(); /* Wait for completion of call_rcu()'s */
1995 MODULE_ALIAS("rpc-auth-6");
1996 MODULE_LICENSE("GPL");
1997 module_param_named(expired_cred_retry_delay,
1998 gss_expired_cred_retry_delay,
2000 MODULE_PARM_DESC(expired_cred_retry_delay, "Timeout (in seconds) until "
2001 "the RPC engine retries an expired credential");
2003 module_param_named(key_expire_timeo,
2004 gss_key_expire_timeo,
2006 MODULE_PARM_DESC(key_expire_timeo, "Time (in seconds) at the end of a "
2007 "credential keys lifetime where the NFS layer cleans up "
2008 "prior to key expiration");
2010 module_init(init_rpcsec_gss)
2011 module_exit(exit_rpcsec_gss)