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 <linux/uaccess.h>
54 #include <linux/hashtable.h>
56 #include "auth_gss_internal.h"
59 static const struct rpc_authops authgss_ops;
61 static const struct rpc_credops gss_credops;
62 static const struct rpc_credops gss_nullops;
64 #define GSS_RETRY_EXPIRED 5
65 static unsigned int gss_expired_cred_retry_delay = GSS_RETRY_EXPIRED;
67 #define GSS_KEY_EXPIRE_TIMEO 240
68 static unsigned int gss_key_expire_timeo = GSS_KEY_EXPIRE_TIMEO;
70 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
71 # define RPCDBG_FACILITY RPCDBG_AUTH
74 #define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
75 /* length of a krb5 verifier (48), plus data added before arguments when
76 * using integrity (two 4-byte integers): */
77 #define GSS_VERF_SLACK 100
79 static DEFINE_HASHTABLE(gss_auth_hash_table, 4);
80 static DEFINE_SPINLOCK(gss_auth_hash_lock);
83 struct rpc_pipe_dir_object pdo;
84 struct rpc_pipe *pipe;
85 struct rpc_clnt *clnt;
92 struct hlist_node hash;
93 struct rpc_auth rpc_auth;
94 struct gss_api_mech *mech;
95 enum rpc_gss_svc service;
96 struct rpc_clnt *client;
99 * There are two upcall pipes; dentry[1], named "gssd", is used
100 * for the new text-based upcall; dentry[0] is named after the
101 * mechanism (for example, "krb5") and exists for
102 * backwards-compatibility with older gssd's.
104 struct gss_pipe *gss_pipe[2];
105 const char *target_name;
108 /* pipe_version >= 0 if and only if someone has a pipe open. */
109 static DEFINE_SPINLOCK(pipe_version_lock);
110 static struct rpc_wait_queue pipe_version_rpc_waitqueue;
111 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue);
112 static void gss_put_auth(struct gss_auth *gss_auth);
114 static void gss_free_ctx(struct gss_cl_ctx *);
115 static const struct rpc_pipe_ops gss_upcall_ops_v0;
116 static const struct rpc_pipe_ops gss_upcall_ops_v1;
118 static inline struct gss_cl_ctx *
119 gss_get_ctx(struct gss_cl_ctx *ctx)
121 refcount_inc(&ctx->count);
126 gss_put_ctx(struct gss_cl_ctx *ctx)
128 if (refcount_dec_and_test(&ctx->count))
133 * called by gss_upcall_callback and gss_create_upcall in order
134 * to set the gss context. The actual exchange of an old context
135 * and a new one is protected by the pipe->lock.
138 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
140 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
142 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
145 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
146 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
147 smp_mb__before_atomic();
148 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
151 static struct gss_cl_ctx *
152 gss_cred_get_ctx(struct rpc_cred *cred)
154 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
155 struct gss_cl_ctx *ctx = NULL;
158 ctx = rcu_dereference(gss_cred->gc_ctx);
165 static struct gss_cl_ctx *
166 gss_alloc_context(void)
168 struct gss_cl_ctx *ctx;
170 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
172 ctx->gc_proc = RPC_GSS_PROC_DATA;
173 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
174 spin_lock_init(&ctx->gc_seq_lock);
175 refcount_set(&ctx->count,1);
180 #define GSSD_MIN_TIMEOUT (60 * 60)
182 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
186 unsigned int timeout;
187 unsigned long now = jiffies;
191 /* First unsigned int gives the remaining lifetime in seconds of the
192 * credential - e.g. the remaining TGT lifetime for Kerberos or
193 * the -t value passed to GSSD.
195 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
199 timeout = GSSD_MIN_TIMEOUT;
200 ctx->gc_expiry = now + ((unsigned long)timeout * HZ);
201 /* Sequence number window. Determines the maximum number of
202 * simultaneous requests
204 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
207 ctx->gc_win = window_size;
208 /* gssd signals an error by passing ctx->gc_win = 0: */
209 if (ctx->gc_win == 0) {
211 * in which case, p points to an error code. Anything other
212 * than -EKEYEXPIRED gets converted to -EACCES.
214 p = simple_get_bytes(p, end, &ret, sizeof(ret));
216 p = (ret == -EKEYEXPIRED) ? ERR_PTR(-EKEYEXPIRED) :
220 /* copy the opaque wire context */
221 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
224 /* import the opaque security context */
225 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
228 q = (const void *)((const char *)p + seclen);
229 if (unlikely(q > end || q < p)) {
230 p = ERR_PTR(-EFAULT);
233 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx, NULL, GFP_NOFS);
239 /* is there any trailing data? */
245 /* pull in acceptor name (if there is one) */
246 p = simple_get_netobj(q, end, &ctx->gc_acceptor);
250 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u acceptor %.*s\n",
251 __func__, ctx->gc_expiry, now, timeout, ctx->gc_acceptor.len,
252 ctx->gc_acceptor.data);
255 dprintk("RPC: %s returns error %ld\n", __func__, -PTR_ERR(p));
259 #define UPCALL_BUF_LEN 128
261 struct gss_upcall_msg {
264 struct rpc_pipe_msg msg;
265 struct list_head list;
266 struct gss_auth *auth;
267 struct rpc_pipe *pipe;
268 struct rpc_wait_queue rpc_waitqueue;
269 wait_queue_head_t waitqueue;
270 struct gss_cl_ctx *ctx;
271 char databuf[UPCALL_BUF_LEN];
274 static int get_pipe_version(struct net *net)
276 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
279 spin_lock(&pipe_version_lock);
280 if (sn->pipe_version >= 0) {
281 atomic_inc(&sn->pipe_users);
282 ret = sn->pipe_version;
285 spin_unlock(&pipe_version_lock);
289 static void put_pipe_version(struct net *net)
291 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
293 if (atomic_dec_and_lock(&sn->pipe_users, &pipe_version_lock)) {
294 sn->pipe_version = -1;
295 spin_unlock(&pipe_version_lock);
300 gss_release_msg(struct gss_upcall_msg *gss_msg)
302 struct net *net = gss_msg->auth->net;
303 if (!refcount_dec_and_test(&gss_msg->count))
305 put_pipe_version(net);
306 BUG_ON(!list_empty(&gss_msg->list));
307 if (gss_msg->ctx != NULL)
308 gss_put_ctx(gss_msg->ctx);
309 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
310 gss_put_auth(gss_msg->auth);
314 static struct gss_upcall_msg *
315 __gss_find_upcall(struct rpc_pipe *pipe, kuid_t uid, const struct gss_auth *auth)
317 struct gss_upcall_msg *pos;
318 list_for_each_entry(pos, &pipe->in_downcall, list) {
319 if (!uid_eq(pos->uid, uid))
321 if (pos->auth->service != auth->service)
323 refcount_inc(&pos->count);
324 dprintk("RPC: %s found msg %p\n", __func__, pos);
327 dprintk("RPC: %s found nothing\n", __func__);
331 /* Try to add an upcall to the pipefs queue.
332 * If an upcall owned by our uid already exists, then we return a reference
333 * to that upcall instead of adding the new upcall.
335 static inline struct gss_upcall_msg *
336 gss_add_msg(struct gss_upcall_msg *gss_msg)
338 struct rpc_pipe *pipe = gss_msg->pipe;
339 struct gss_upcall_msg *old;
341 spin_lock(&pipe->lock);
342 old = __gss_find_upcall(pipe, gss_msg->uid, gss_msg->auth);
344 refcount_inc(&gss_msg->count);
345 list_add(&gss_msg->list, &pipe->in_downcall);
348 spin_unlock(&pipe->lock);
353 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
355 list_del_init(&gss_msg->list);
356 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
357 wake_up_all(&gss_msg->waitqueue);
358 refcount_dec(&gss_msg->count);
362 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
364 struct rpc_pipe *pipe = gss_msg->pipe;
366 if (list_empty(&gss_msg->list))
368 spin_lock(&pipe->lock);
369 if (!list_empty(&gss_msg->list))
370 __gss_unhash_msg(gss_msg);
371 spin_unlock(&pipe->lock);
375 gss_handle_downcall_result(struct gss_cred *gss_cred, struct gss_upcall_msg *gss_msg)
377 switch (gss_msg->msg.errno) {
379 if (gss_msg->ctx == NULL)
381 clear_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
382 gss_cred_set_ctx(&gss_cred->gc_base, gss_msg->ctx);
385 set_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
387 gss_cred->gc_upcall_timestamp = jiffies;
388 gss_cred->gc_upcall = NULL;
389 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
393 gss_upcall_callback(struct rpc_task *task)
395 struct gss_cred *gss_cred = container_of(task->tk_rqstp->rq_cred,
396 struct gss_cred, gc_base);
397 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
398 struct rpc_pipe *pipe = gss_msg->pipe;
400 spin_lock(&pipe->lock);
401 gss_handle_downcall_result(gss_cred, gss_msg);
402 spin_unlock(&pipe->lock);
403 task->tk_status = gss_msg->msg.errno;
404 gss_release_msg(gss_msg);
407 static void gss_encode_v0_msg(struct gss_upcall_msg *gss_msg)
409 uid_t uid = from_kuid(&init_user_ns, gss_msg->uid);
410 memcpy(gss_msg->databuf, &uid, sizeof(uid));
411 gss_msg->msg.data = gss_msg->databuf;
412 gss_msg->msg.len = sizeof(uid);
414 BUILD_BUG_ON(sizeof(uid) > sizeof(gss_msg->databuf));
417 static int gss_encode_v1_msg(struct gss_upcall_msg *gss_msg,
418 const char *service_name,
419 const char *target_name)
421 struct gss_api_mech *mech = gss_msg->auth->mech;
422 char *p = gss_msg->databuf;
423 size_t buflen = sizeof(gss_msg->databuf);
426 len = scnprintf(p, buflen, "mech=%s uid=%d ", mech->gm_name,
427 from_kuid(&init_user_ns, gss_msg->uid));
430 gss_msg->msg.len = len;
432 len = scnprintf(p, buflen, "target=%s ", target_name);
435 gss_msg->msg.len += len;
437 if (service_name != NULL) {
438 len = scnprintf(p, buflen, "service=%s ", service_name);
441 gss_msg->msg.len += len;
443 if (mech->gm_upcall_enctypes) {
444 len = scnprintf(p, buflen, "enctypes=%s ",
445 mech->gm_upcall_enctypes);
448 gss_msg->msg.len += len;
450 len = scnprintf(p, buflen, "\n");
453 gss_msg->msg.len += len;
455 gss_msg->msg.data = gss_msg->databuf;
462 static struct gss_upcall_msg *
463 gss_alloc_msg(struct gss_auth *gss_auth,
464 kuid_t uid, const char *service_name)
466 struct gss_upcall_msg *gss_msg;
470 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
473 vers = get_pipe_version(gss_auth->net);
477 gss_msg->pipe = gss_auth->gss_pipe[vers]->pipe;
478 INIT_LIST_HEAD(&gss_msg->list);
479 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
480 init_waitqueue_head(&gss_msg->waitqueue);
481 refcount_set(&gss_msg->count, 1);
483 gss_msg->auth = gss_auth;
486 gss_encode_v0_msg(gss_msg);
489 err = gss_encode_v1_msg(gss_msg, service_name, gss_auth->target_name);
491 goto err_put_pipe_version;
493 kref_get(&gss_auth->kref);
495 err_put_pipe_version:
496 put_pipe_version(gss_auth->net);
503 static struct gss_upcall_msg *
504 gss_setup_upcall(struct gss_auth *gss_auth, struct rpc_cred *cred)
506 struct gss_cred *gss_cred = container_of(cred,
507 struct gss_cred, gc_base);
508 struct gss_upcall_msg *gss_new, *gss_msg;
509 kuid_t uid = cred->cr_uid;
511 gss_new = gss_alloc_msg(gss_auth, uid, gss_cred->gc_principal);
514 gss_msg = gss_add_msg(gss_new);
515 if (gss_msg == gss_new) {
517 refcount_inc(&gss_msg->count);
518 res = rpc_queue_upcall(gss_new->pipe, &gss_new->msg);
520 gss_unhash_msg(gss_new);
521 refcount_dec(&gss_msg->count);
522 gss_release_msg(gss_new);
523 gss_msg = ERR_PTR(res);
526 gss_release_msg(gss_new);
530 static void warn_gssd(void)
532 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
536 gss_refresh_upcall(struct rpc_task *task)
538 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
539 struct gss_auth *gss_auth = container_of(cred->cr_auth,
540 struct gss_auth, rpc_auth);
541 struct gss_cred *gss_cred = container_of(cred,
542 struct gss_cred, gc_base);
543 struct gss_upcall_msg *gss_msg;
544 struct rpc_pipe *pipe;
547 dprintk("RPC: %5u %s for uid %u\n",
548 task->tk_pid, __func__, from_kuid(&init_user_ns, cred->cr_uid));
549 gss_msg = gss_setup_upcall(gss_auth, cred);
550 if (PTR_ERR(gss_msg) == -EAGAIN) {
551 /* XXX: warning on the first, under the assumption we
552 * shouldn't normally hit this case on a refresh. */
554 task->tk_timeout = 15*HZ;
555 rpc_sleep_on(&pipe_version_rpc_waitqueue, task, NULL);
558 if (IS_ERR(gss_msg)) {
559 err = PTR_ERR(gss_msg);
562 pipe = gss_msg->pipe;
563 spin_lock(&pipe->lock);
564 if (gss_cred->gc_upcall != NULL)
565 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
566 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
567 task->tk_timeout = 0;
568 gss_cred->gc_upcall = gss_msg;
569 /* gss_upcall_callback will release the reference to gss_upcall_msg */
570 refcount_inc(&gss_msg->count);
571 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
573 gss_handle_downcall_result(gss_cred, gss_msg);
574 err = gss_msg->msg.errno;
576 spin_unlock(&pipe->lock);
577 gss_release_msg(gss_msg);
579 dprintk("RPC: %5u %s for uid %u result %d\n",
580 task->tk_pid, __func__,
581 from_kuid(&init_user_ns, cred->cr_uid), err);
586 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
588 struct net *net = gss_auth->net;
589 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
590 struct rpc_pipe *pipe;
591 struct rpc_cred *cred = &gss_cred->gc_base;
592 struct gss_upcall_msg *gss_msg;
596 dprintk("RPC: %s for uid %u\n",
597 __func__, from_kuid(&init_user_ns, cred->cr_uid));
600 /* if gssd is down, just skip upcalling altogether */
601 if (!gssd_running(net)) {
605 gss_msg = gss_setup_upcall(gss_auth, cred);
606 if (PTR_ERR(gss_msg) == -EAGAIN) {
607 err = wait_event_interruptible_timeout(pipe_version_waitqueue,
608 sn->pipe_version >= 0, 15 * HZ);
609 if (sn->pipe_version < 0) {
617 if (IS_ERR(gss_msg)) {
618 err = PTR_ERR(gss_msg);
621 pipe = gss_msg->pipe;
623 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_KILLABLE);
624 spin_lock(&pipe->lock);
625 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
628 spin_unlock(&pipe->lock);
629 if (fatal_signal_pending(current)) {
636 gss_cred_set_ctx(cred, gss_msg->ctx);
638 err = gss_msg->msg.errno;
639 spin_unlock(&pipe->lock);
641 finish_wait(&gss_msg->waitqueue, &wait);
642 gss_release_msg(gss_msg);
644 dprintk("RPC: %s for uid %u result %d\n",
645 __func__, from_kuid(&init_user_ns, cred->cr_uid), err);
649 static struct gss_upcall_msg *
650 gss_find_downcall(struct rpc_pipe *pipe, kuid_t uid)
652 struct gss_upcall_msg *pos;
653 list_for_each_entry(pos, &pipe->in_downcall, list) {
654 if (!uid_eq(pos->uid, uid))
656 if (!rpc_msg_is_inflight(&pos->msg))
658 refcount_inc(&pos->count);
664 #define MSG_BUF_MAXSIZE 1024
667 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
671 struct gss_upcall_msg *gss_msg;
672 struct rpc_pipe *pipe = RPC_I(file_inode(filp))->pipe;
673 struct gss_cl_ctx *ctx;
676 ssize_t err = -EFBIG;
678 if (mlen > MSG_BUF_MAXSIZE)
681 buf = kmalloc(mlen, GFP_NOFS);
686 if (copy_from_user(buf, src, mlen))
689 end = (const void *)((char *)buf + mlen);
690 p = simple_get_bytes(buf, end, &id, sizeof(id));
696 uid = make_kuid(&init_user_ns, id);
697 if (!uid_valid(uid)) {
703 ctx = gss_alloc_context();
708 /* Find a matching upcall */
709 spin_lock(&pipe->lock);
710 gss_msg = gss_find_downcall(pipe, uid);
711 if (gss_msg == NULL) {
712 spin_unlock(&pipe->lock);
715 list_del_init(&gss_msg->list);
716 spin_unlock(&pipe->lock);
718 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
724 gss_msg->msg.errno = err;
731 gss_msg->msg.errno = -EAGAIN;
734 printk(KERN_CRIT "%s: bad return from "
735 "gss_fill_context: %zd\n", __func__, err);
736 gss_msg->msg.errno = -EIO;
738 goto err_release_msg;
740 gss_msg->ctx = gss_get_ctx(ctx);
744 spin_lock(&pipe->lock);
745 __gss_unhash_msg(gss_msg);
746 spin_unlock(&pipe->lock);
747 gss_release_msg(gss_msg);
753 dprintk("RPC: %s returning %zd\n", __func__, err);
757 static int gss_pipe_open(struct inode *inode, int new_version)
759 struct net *net = inode->i_sb->s_fs_info;
760 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
763 spin_lock(&pipe_version_lock);
764 if (sn->pipe_version < 0) {
765 /* First open of any gss pipe determines the version: */
766 sn->pipe_version = new_version;
767 rpc_wake_up(&pipe_version_rpc_waitqueue);
768 wake_up(&pipe_version_waitqueue);
769 } else if (sn->pipe_version != new_version) {
770 /* Trying to open a pipe of a different version */
774 atomic_inc(&sn->pipe_users);
776 spin_unlock(&pipe_version_lock);
781 static int gss_pipe_open_v0(struct inode *inode)
783 return gss_pipe_open(inode, 0);
786 static int gss_pipe_open_v1(struct inode *inode)
788 return gss_pipe_open(inode, 1);
792 gss_pipe_release(struct inode *inode)
794 struct net *net = inode->i_sb->s_fs_info;
795 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
796 struct gss_upcall_msg *gss_msg;
799 spin_lock(&pipe->lock);
800 list_for_each_entry(gss_msg, &pipe->in_downcall, list) {
802 if (!list_empty(&gss_msg->msg.list))
804 gss_msg->msg.errno = -EPIPE;
805 refcount_inc(&gss_msg->count);
806 __gss_unhash_msg(gss_msg);
807 spin_unlock(&pipe->lock);
808 gss_release_msg(gss_msg);
811 spin_unlock(&pipe->lock);
813 put_pipe_version(net);
817 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
819 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
821 if (msg->errno < 0) {
822 dprintk("RPC: %s releasing msg %p\n",
824 refcount_inc(&gss_msg->count);
825 gss_unhash_msg(gss_msg);
826 if (msg->errno == -ETIMEDOUT)
828 gss_release_msg(gss_msg);
830 gss_release_msg(gss_msg);
833 static void gss_pipe_dentry_destroy(struct dentry *dir,
834 struct rpc_pipe_dir_object *pdo)
836 struct gss_pipe *gss_pipe = pdo->pdo_data;
837 struct rpc_pipe *pipe = gss_pipe->pipe;
839 if (pipe->dentry != NULL) {
840 rpc_unlink(pipe->dentry);
845 static int gss_pipe_dentry_create(struct dentry *dir,
846 struct rpc_pipe_dir_object *pdo)
848 struct gss_pipe *p = pdo->pdo_data;
849 struct dentry *dentry;
851 dentry = rpc_mkpipe_dentry(dir, p->name, p->clnt, p->pipe);
853 return PTR_ERR(dentry);
854 p->pipe->dentry = dentry;
858 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops = {
859 .create = gss_pipe_dentry_create,
860 .destroy = gss_pipe_dentry_destroy,
863 static struct gss_pipe *gss_pipe_alloc(struct rpc_clnt *clnt,
865 const struct rpc_pipe_ops *upcall_ops)
870 p = kmalloc(sizeof(*p), GFP_KERNEL);
873 p->pipe = rpc_mkpipe_data(upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
874 if (IS_ERR(p->pipe)) {
875 err = PTR_ERR(p->pipe);
876 goto err_free_gss_pipe;
881 rpc_init_pipe_dir_object(&p->pdo,
882 &gss_pipe_dir_object_ops,
891 struct gss_alloc_pdo {
892 struct rpc_clnt *clnt;
894 const struct rpc_pipe_ops *upcall_ops;
897 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object *pdo, void *data)
899 struct gss_pipe *gss_pipe;
900 struct gss_alloc_pdo *args = data;
902 if (pdo->pdo_ops != &gss_pipe_dir_object_ops)
904 gss_pipe = container_of(pdo, struct gss_pipe, pdo);
905 if (strcmp(gss_pipe->name, args->name) != 0)
907 if (!kref_get_unless_zero(&gss_pipe->kref))
912 static struct rpc_pipe_dir_object *gss_pipe_alloc_pdo(void *data)
914 struct gss_pipe *gss_pipe;
915 struct gss_alloc_pdo *args = data;
917 gss_pipe = gss_pipe_alloc(args->clnt, args->name, args->upcall_ops);
918 if (!IS_ERR(gss_pipe))
919 return &gss_pipe->pdo;
923 static struct gss_pipe *gss_pipe_get(struct rpc_clnt *clnt,
925 const struct rpc_pipe_ops *upcall_ops)
927 struct net *net = rpc_net_ns(clnt);
928 struct rpc_pipe_dir_object *pdo;
929 struct gss_alloc_pdo args = {
932 .upcall_ops = upcall_ops,
935 pdo = rpc_find_or_alloc_pipe_dir_object(net,
936 &clnt->cl_pipedir_objects,
941 return container_of(pdo, struct gss_pipe, pdo);
942 return ERR_PTR(-ENOMEM);
945 static void __gss_pipe_free(struct gss_pipe *p)
947 struct rpc_clnt *clnt = p->clnt;
948 struct net *net = rpc_net_ns(clnt);
950 rpc_remove_pipe_dir_object(net,
951 &clnt->cl_pipedir_objects,
953 rpc_destroy_pipe_data(p->pipe);
957 static void __gss_pipe_release(struct kref *kref)
959 struct gss_pipe *p = container_of(kref, struct gss_pipe, kref);
964 static void gss_pipe_free(struct gss_pipe *p)
967 kref_put(&p->kref, __gss_pipe_release);
971 * NOTE: we have the opportunity to use different
972 * parameters based on the input flavor (which must be a pseudoflavor)
974 static struct gss_auth *
975 gss_create_new(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
977 rpc_authflavor_t flavor = args->pseudoflavor;
978 struct gss_auth *gss_auth;
979 struct gss_pipe *gss_pipe;
980 struct rpc_auth * auth;
981 int err = -ENOMEM; /* XXX? */
983 dprintk("RPC: creating GSS authenticator for client %p\n", clnt);
985 if (!try_module_get(THIS_MODULE))
987 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
989 INIT_HLIST_NODE(&gss_auth->hash);
990 gss_auth->target_name = NULL;
991 if (args->target_name) {
992 gss_auth->target_name = kstrdup(args->target_name, GFP_KERNEL);
993 if (gss_auth->target_name == NULL)
996 gss_auth->client = clnt;
997 gss_auth->net = get_net(rpc_net_ns(clnt));
999 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
1000 if (!gss_auth->mech) {
1001 dprintk("RPC: Pseudoflavor %d not found!\n", flavor);
1004 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
1005 if (gss_auth->service == 0)
1007 if (!gssd_running(gss_auth->net))
1009 auth = &gss_auth->rpc_auth;
1010 auth->au_cslack = GSS_CRED_SLACK >> 2;
1011 auth->au_rslack = GSS_VERF_SLACK >> 2;
1013 auth->au_ops = &authgss_ops;
1014 auth->au_flavor = flavor;
1015 if (gss_pseudoflavor_to_datatouch(gss_auth->mech, flavor))
1016 auth->au_flags |= RPCAUTH_AUTH_DATATOUCH;
1017 atomic_set(&auth->au_count, 1);
1018 kref_init(&gss_auth->kref);
1020 err = rpcauth_init_credcache(auth);
1024 * Note: if we created the old pipe first, then someone who
1025 * examined the directory at the right moment might conclude
1026 * that we supported only the old pipe. So we instead create
1027 * the new pipe first.
1029 gss_pipe = gss_pipe_get(clnt, "gssd", &gss_upcall_ops_v1);
1030 if (IS_ERR(gss_pipe)) {
1031 err = PTR_ERR(gss_pipe);
1032 goto err_destroy_credcache;
1034 gss_auth->gss_pipe[1] = gss_pipe;
1036 gss_pipe = gss_pipe_get(clnt, gss_auth->mech->gm_name,
1037 &gss_upcall_ops_v0);
1038 if (IS_ERR(gss_pipe)) {
1039 err = PTR_ERR(gss_pipe);
1040 goto err_destroy_pipe_1;
1042 gss_auth->gss_pipe[0] = gss_pipe;
1046 gss_pipe_free(gss_auth->gss_pipe[1]);
1047 err_destroy_credcache:
1048 rpcauth_destroy_credcache(auth);
1050 gss_mech_put(gss_auth->mech);
1052 put_net(gss_auth->net);
1054 kfree(gss_auth->target_name);
1057 module_put(THIS_MODULE);
1058 return ERR_PTR(err);
1062 gss_free(struct gss_auth *gss_auth)
1064 gss_pipe_free(gss_auth->gss_pipe[0]);
1065 gss_pipe_free(gss_auth->gss_pipe[1]);
1066 gss_mech_put(gss_auth->mech);
1067 put_net(gss_auth->net);
1068 kfree(gss_auth->target_name);
1071 module_put(THIS_MODULE);
1075 gss_free_callback(struct kref *kref)
1077 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
1083 gss_put_auth(struct gss_auth *gss_auth)
1085 kref_put(&gss_auth->kref, gss_free_callback);
1089 gss_destroy(struct rpc_auth *auth)
1091 struct gss_auth *gss_auth = container_of(auth,
1092 struct gss_auth, rpc_auth);
1094 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1095 auth, auth->au_flavor);
1097 if (hash_hashed(&gss_auth->hash)) {
1098 spin_lock(&gss_auth_hash_lock);
1099 hash_del(&gss_auth->hash);
1100 spin_unlock(&gss_auth_hash_lock);
1103 gss_pipe_free(gss_auth->gss_pipe[0]);
1104 gss_auth->gss_pipe[0] = NULL;
1105 gss_pipe_free(gss_auth->gss_pipe[1]);
1106 gss_auth->gss_pipe[1] = NULL;
1107 rpcauth_destroy_credcache(auth);
1109 gss_put_auth(gss_auth);
1113 * Auths may be shared between rpc clients that were cloned from a
1114 * common client with the same xprt, if they also share the flavor and
1117 * The auth is looked up from the oldest parent sharing the same
1118 * cl_xprt, and the auth itself references only that common parent
1119 * (which is guaranteed to last as long as any of its descendants).
1121 static struct gss_auth *
1122 gss_auth_find_or_add_hashed(struct rpc_auth_create_args *args,
1123 struct rpc_clnt *clnt,
1124 struct gss_auth *new)
1126 struct gss_auth *gss_auth;
1127 unsigned long hashval = (unsigned long)clnt;
1129 spin_lock(&gss_auth_hash_lock);
1130 hash_for_each_possible(gss_auth_hash_table,
1134 if (gss_auth->client != clnt)
1136 if (gss_auth->rpc_auth.au_flavor != args->pseudoflavor)
1138 if (gss_auth->target_name != args->target_name) {
1139 if (gss_auth->target_name == NULL)
1141 if (args->target_name == NULL)
1143 if (strcmp(gss_auth->target_name, args->target_name))
1146 if (!atomic_inc_not_zero(&gss_auth->rpc_auth.au_count))
1151 hash_add(gss_auth_hash_table, &new->hash, hashval);
1154 spin_unlock(&gss_auth_hash_lock);
1158 static struct gss_auth *
1159 gss_create_hashed(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1161 struct gss_auth *gss_auth;
1162 struct gss_auth *new;
1164 gss_auth = gss_auth_find_or_add_hashed(args, clnt, NULL);
1165 if (gss_auth != NULL)
1167 new = gss_create_new(args, clnt);
1170 gss_auth = gss_auth_find_or_add_hashed(args, clnt, new);
1171 if (gss_auth != new)
1172 gss_destroy(&new->rpc_auth);
1177 static struct rpc_auth *
1178 gss_create(struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1180 struct gss_auth *gss_auth;
1181 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
1183 while (clnt != clnt->cl_parent) {
1184 struct rpc_clnt *parent = clnt->cl_parent;
1185 /* Find the original parent for this transport */
1186 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
1191 gss_auth = gss_create_hashed(args, clnt);
1192 if (IS_ERR(gss_auth))
1193 return ERR_CAST(gss_auth);
1194 return &gss_auth->rpc_auth;
1198 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1199 * to the server with the GSS control procedure field set to
1200 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1201 * all RPCSEC_GSS state associated with that context.
1204 gss_destroying_context(struct rpc_cred *cred)
1206 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1207 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1208 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1209 struct rpc_task *task;
1211 if (test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) == 0)
1214 ctx->gc_proc = RPC_GSS_PROC_DESTROY;
1215 cred->cr_ops = &gss_nullops;
1217 /* Take a reference to ensure the cred will be destroyed either
1218 * by the RPC call or by the put_rpccred() below */
1221 task = rpc_call_null(gss_auth->client, cred, RPC_TASK_ASYNC|RPC_TASK_SOFT);
1229 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1230 * to create a new cred or context, so they check that things have been
1231 * allocated before freeing them. */
1233 gss_do_free_ctx(struct gss_cl_ctx *ctx)
1235 dprintk("RPC: %s\n", __func__);
1237 gss_delete_sec_context(&ctx->gc_gss_ctx);
1238 kfree(ctx->gc_wire_ctx.data);
1239 kfree(ctx->gc_acceptor.data);
1244 gss_free_ctx_callback(struct rcu_head *head)
1246 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
1247 gss_do_free_ctx(ctx);
1251 gss_free_ctx(struct gss_cl_ctx *ctx)
1253 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
1257 gss_free_cred(struct gss_cred *gss_cred)
1259 dprintk("RPC: %s cred=%p\n", __func__, gss_cred);
1264 gss_free_cred_callback(struct rcu_head *head)
1266 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
1267 gss_free_cred(gss_cred);
1271 gss_destroy_nullcred(struct rpc_cred *cred)
1273 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1274 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1275 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1277 RCU_INIT_POINTER(gss_cred->gc_ctx, NULL);
1278 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
1281 gss_put_auth(gss_auth);
1285 gss_destroy_cred(struct rpc_cred *cred)
1288 if (gss_destroying_context(cred))
1290 gss_destroy_nullcred(cred);
1294 gss_hash_cred(struct auth_cred *acred, unsigned int hashbits)
1296 return hash_64(from_kuid(&init_user_ns, acred->uid), hashbits);
1300 * Lookup RPCSEC_GSS cred for the current process
1302 static struct rpc_cred *
1303 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1305 return rpcauth_lookup_credcache(auth, acred, flags, GFP_NOFS);
1308 static struct rpc_cred *
1309 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp)
1311 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1312 struct gss_cred *cred = NULL;
1315 dprintk("RPC: %s for uid %d, flavor %d\n",
1316 __func__, from_kuid(&init_user_ns, acred->uid),
1319 if (!(cred = kzalloc(sizeof(*cred), gfp)))
1322 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
1324 * Note: in order to force a call to call_refresh(), we deliberately
1325 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1327 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
1328 cred->gc_service = gss_auth->service;
1329 cred->gc_principal = NULL;
1330 if (acred->machine_cred)
1331 cred->gc_principal = acred->principal;
1332 kref_get(&gss_auth->kref);
1333 return &cred->gc_base;
1336 dprintk("RPC: %s failed with error %d\n", __func__, err);
1337 return ERR_PTR(err);
1341 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
1343 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1344 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
1348 err = gss_create_upcall(gss_auth, gss_cred);
1349 } while (err == -EAGAIN);
1354 gss_stringify_acceptor(struct rpc_cred *cred)
1356 char *string = NULL;
1357 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1358 struct gss_cl_ctx *ctx;
1360 struct xdr_netobj *acceptor;
1363 ctx = rcu_dereference(gss_cred->gc_ctx);
1367 len = ctx->gc_acceptor.len;
1370 /* no point if there's no string */
1374 string = kmalloc(len + 1, GFP_KERNEL);
1379 ctx = rcu_dereference(gss_cred->gc_ctx);
1381 /* did the ctx disappear or was it replaced by one with no acceptor? */
1382 if (!ctx || !ctx->gc_acceptor.len) {
1388 acceptor = &ctx->gc_acceptor;
1391 * Did we find a new acceptor that's longer than the original? Allocate
1392 * a longer buffer and try again.
1394 if (len < acceptor->len) {
1395 len = acceptor->len;
1401 memcpy(string, acceptor->data, acceptor->len);
1402 string[acceptor->len] = '\0';
1409 * Returns -EACCES if GSS context is NULL or will expire within the
1410 * timeout (miliseconds)
1413 gss_key_timeout(struct rpc_cred *rc)
1415 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1416 struct gss_cl_ctx *ctx;
1417 unsigned long timeout = jiffies + (gss_key_expire_timeo * HZ);
1421 ctx = rcu_dereference(gss_cred->gc_ctx);
1422 if (!ctx || time_after(timeout, ctx->gc_expiry))
1430 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
1432 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1433 struct gss_cl_ctx *ctx;
1436 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
1438 /* Don't match with creds that have expired. */
1440 ctx = rcu_dereference(gss_cred->gc_ctx);
1441 if (!ctx || time_after(jiffies, ctx->gc_expiry)) {
1446 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
1449 if (acred->principal != NULL) {
1450 if (gss_cred->gc_principal == NULL)
1452 ret = strcmp(acred->principal, gss_cred->gc_principal) == 0;
1455 if (gss_cred->gc_principal != NULL)
1457 ret = uid_eq(rc->cr_uid, acred->uid);
1463 /* Notify acred users of GSS context expiration timeout */
1464 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags) &&
1465 (gss_key_timeout(rc) != 0)) {
1466 /* test will now be done from generic cred */
1467 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags);
1468 /* tell NFS layer that key will expire soon */
1469 set_bit(RPC_CRED_KEY_EXPIRE_SOON, &acred->ac_flags);
1475 * Marshal credentials.
1476 * Maybe we should keep a cached credential for performance reasons.
1479 gss_marshal(struct rpc_task *task, __be32 *p)
1481 struct rpc_rqst *req = task->tk_rqstp;
1482 struct rpc_cred *cred = req->rq_cred;
1483 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1485 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1488 struct xdr_netobj mic;
1490 struct xdr_buf verf_buf;
1492 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1494 *p++ = htonl(RPC_AUTH_GSS);
1497 spin_lock(&ctx->gc_seq_lock);
1498 req->rq_seqno = ctx->gc_seq++;
1499 spin_unlock(&ctx->gc_seq_lock);
1501 *p++ = htonl((u32) RPC_GSS_VERSION);
1502 *p++ = htonl((u32) ctx->gc_proc);
1503 *p++ = htonl((u32) req->rq_seqno);
1504 *p++ = htonl((u32) gss_cred->gc_service);
1505 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
1506 *cred_len = htonl((p - (cred_len + 1)) << 2);
1508 /* We compute the checksum for the verifier over the xdr-encoded bytes
1509 * starting with the xid and ending at the end of the credential: */
1510 iov.iov_base = xprt_skip_transport_header(req->rq_xprt,
1511 req->rq_snd_buf.head[0].iov_base);
1512 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
1513 xdr_buf_from_iov(&iov, &verf_buf);
1515 /* set verifier flavor*/
1516 *p++ = htonl(RPC_AUTH_GSS);
1518 mic.data = (u8 *)(p + 1);
1519 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1520 if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
1521 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1522 } else if (maj_stat != 0) {
1523 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
1526 p = xdr_encode_opaque(p, NULL, mic.len);
1534 static int gss_renew_cred(struct rpc_task *task)
1536 struct rpc_cred *oldcred = task->tk_rqstp->rq_cred;
1537 struct gss_cred *gss_cred = container_of(oldcred,
1540 struct rpc_auth *auth = oldcred->cr_auth;
1541 struct auth_cred acred = {
1542 .uid = oldcred->cr_uid,
1543 .principal = gss_cred->gc_principal,
1544 .machine_cred = (gss_cred->gc_principal != NULL ? 1 : 0),
1546 struct rpc_cred *new;
1548 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
1550 return PTR_ERR(new);
1551 task->tk_rqstp->rq_cred = new;
1552 put_rpccred(oldcred);
1556 static int gss_cred_is_negative_entry(struct rpc_cred *cred)
1558 if (test_bit(RPCAUTH_CRED_NEGATIVE, &cred->cr_flags)) {
1559 unsigned long now = jiffies;
1560 unsigned long begin, expire;
1561 struct gss_cred *gss_cred;
1563 gss_cred = container_of(cred, struct gss_cred, gc_base);
1564 begin = gss_cred->gc_upcall_timestamp;
1565 expire = begin + gss_expired_cred_retry_delay * HZ;
1567 if (time_in_range_open(now, begin, expire))
1574 * Refresh credentials. XXX - finish
1577 gss_refresh(struct rpc_task *task)
1579 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1582 if (gss_cred_is_negative_entry(cred))
1583 return -EKEYEXPIRED;
1585 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
1586 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
1587 ret = gss_renew_cred(task);
1590 cred = task->tk_rqstp->rq_cred;
1593 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
1594 ret = gss_refresh_upcall(task);
1599 /* Dummy refresh routine: used only when destroying the context */
1601 gss_refresh_null(struct rpc_task *task)
1607 gss_validate(struct rpc_task *task, __be32 *p)
1609 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1610 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1613 struct xdr_buf verf_buf;
1614 struct xdr_netobj mic;
1617 __be32 *ret = ERR_PTR(-EIO);
1619 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1622 if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
1624 if (flav != RPC_AUTH_GSS)
1626 seq = kmalloc(4, GFP_NOFS);
1629 *seq = htonl(task->tk_rqstp->rq_seqno);
1632 xdr_buf_from_iov(&iov, &verf_buf);
1636 ret = ERR_PTR(-EACCES);
1637 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1638 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1639 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1641 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1642 task->tk_pid, __func__, maj_stat);
1645 /* We leave it to unwrap to calculate au_rslack. For now we just
1646 * calculate the length of the verifier: */
1647 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1649 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1650 task->tk_pid, __func__);
1652 return p + XDR_QUADLEN(len);
1655 dprintk("RPC: %5u %s failed ret %ld.\n", task->tk_pid, __func__,
1661 static void gss_wrap_req_encode(kxdreproc_t encode, struct rpc_rqst *rqstp,
1662 __be32 *p, void *obj)
1664 struct xdr_stream xdr;
1666 xdr_init_encode(&xdr, &rqstp->rq_snd_buf, p);
1667 encode(rqstp, &xdr, obj);
1671 gss_wrap_req_integ(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;
1676 struct xdr_buf integ_buf;
1677 __be32 *integ_len = NULL;
1678 struct xdr_netobj mic;
1686 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1687 *p++ = htonl(rqstp->rq_seqno);
1689 gss_wrap_req_encode(encode, rqstp, p, obj);
1691 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1692 offset, snd_buf->len - offset))
1694 *integ_len = htonl(integ_buf.len);
1696 /* guess whether we're in the head or the tail: */
1697 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1698 iov = snd_buf->tail;
1700 iov = snd_buf->head;
1701 p = iov->iov_base + iov->iov_len;
1702 mic.data = (u8 *)(p + 1);
1704 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1705 status = -EIO; /* XXX? */
1706 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1707 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1710 q = xdr_encode_opaque(p, NULL, mic.len);
1712 offset = (u8 *)q - (u8 *)p;
1713 iov->iov_len += offset;
1714 snd_buf->len += offset;
1719 priv_release_snd_buf(struct rpc_rqst *rqstp)
1723 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1724 __free_page(rqstp->rq_enc_pages[i]);
1725 kfree(rqstp->rq_enc_pages);
1726 rqstp->rq_release_snd_buf = NULL;
1730 alloc_enc_pages(struct rpc_rqst *rqstp)
1732 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1735 if (rqstp->rq_release_snd_buf)
1736 rqstp->rq_release_snd_buf(rqstp);
1738 if (snd_buf->page_len == 0) {
1739 rqstp->rq_enc_pages_num = 0;
1743 first = snd_buf->page_base >> PAGE_SHIFT;
1744 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_SHIFT;
1745 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1747 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
1749 if (!rqstp->rq_enc_pages)
1751 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1752 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1753 if (rqstp->rq_enc_pages[i] == NULL)
1756 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1759 rqstp->rq_enc_pages_num = i;
1760 priv_release_snd_buf(rqstp);
1766 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1767 kxdreproc_t encode, struct rpc_rqst *rqstp,
1768 __be32 *p, void *obj)
1770 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1775 struct page **inpages;
1782 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1783 *p++ = htonl(rqstp->rq_seqno);
1785 gss_wrap_req_encode(encode, rqstp, p, obj);
1787 status = alloc_enc_pages(rqstp);
1790 first = snd_buf->page_base >> PAGE_SHIFT;
1791 inpages = snd_buf->pages + first;
1792 snd_buf->pages = rqstp->rq_enc_pages;
1793 snd_buf->page_base -= first << PAGE_SHIFT;
1795 * Give the tail its own page, in case we need extra space in the
1796 * head when wrapping:
1798 * call_allocate() allocates twice the slack space required
1799 * by the authentication flavor to rq_callsize.
1800 * For GSS, slack is GSS_CRED_SLACK.
1802 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1803 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1804 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1805 snd_buf->tail[0].iov_base = tmp;
1807 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1808 /* slack space should prevent this ever happening: */
1809 BUG_ON(snd_buf->len > snd_buf->buflen);
1811 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1812 * done anyway, so it's safe to put the request on the wire: */
1813 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1814 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1818 *opaque_len = htonl(snd_buf->len - offset);
1819 /* guess whether we're in the head or the tail: */
1820 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1821 iov = snd_buf->tail;
1823 iov = snd_buf->head;
1824 p = iov->iov_base + iov->iov_len;
1825 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1827 iov->iov_len += pad;
1828 snd_buf->len += pad;
1834 gss_wrap_req(struct rpc_task *task,
1835 kxdreproc_t encode, void *rqstp, __be32 *p, void *obj)
1837 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1838 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1840 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1843 dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1844 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1845 /* The spec seems a little ambiguous here, but I think that not
1846 * wrapping context destruction requests makes the most sense.
1848 gss_wrap_req_encode(encode, rqstp, p, obj);
1852 switch (gss_cred->gc_service) {
1853 case RPC_GSS_SVC_NONE:
1854 gss_wrap_req_encode(encode, rqstp, p, obj);
1857 case RPC_GSS_SVC_INTEGRITY:
1858 status = gss_wrap_req_integ(cred, ctx, encode, rqstp, p, obj);
1860 case RPC_GSS_SVC_PRIVACY:
1861 status = gss_wrap_req_priv(cred, ctx, encode, rqstp, p, obj);
1866 dprintk("RPC: %5u %s returning %d\n", task->tk_pid, __func__, status);
1871 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1872 struct rpc_rqst *rqstp, __be32 **p)
1874 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1875 struct xdr_buf integ_buf;
1876 struct xdr_netobj mic;
1877 u32 data_offset, mic_offset;
1882 integ_len = ntohl(*(*p)++);
1885 data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1886 mic_offset = integ_len + data_offset;
1887 if (mic_offset > rcv_buf->len)
1889 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1892 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1893 mic_offset - data_offset))
1896 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1899 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1900 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1901 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1902 if (maj_stat != GSS_S_COMPLETE)
1908 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1909 struct rpc_rqst *rqstp, __be32 **p)
1911 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1917 opaque_len = ntohl(*(*p)++);
1918 offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1919 if (offset + opaque_len > rcv_buf->len)
1921 /* remove padding: */
1922 rcv_buf->len = offset + opaque_len;
1924 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1925 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1926 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1927 if (maj_stat != GSS_S_COMPLETE)
1929 if (ntohl(*(*p)++) != rqstp->rq_seqno)
1936 gss_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
1937 __be32 *p, void *obj)
1939 struct xdr_stream xdr;
1941 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
1942 return decode(rqstp, &xdr, obj);
1946 gss_unwrap_resp(struct rpc_task *task,
1947 kxdrdproc_t decode, void *rqstp, __be32 *p, void *obj)
1949 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1950 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1952 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1954 struct kvec *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
1955 int savedlen = head->iov_len;
1958 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
1960 switch (gss_cred->gc_service) {
1961 case RPC_GSS_SVC_NONE:
1963 case RPC_GSS_SVC_INTEGRITY:
1964 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
1968 case RPC_GSS_SVC_PRIVACY:
1969 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
1974 /* take into account extra slack for integrity and privacy cases: */
1975 cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
1976 + (savedlen - head->iov_len);
1978 status = gss_unwrap_req_decode(decode, rqstp, p, obj);
1981 dprintk("RPC: %5u %s returning %d\n",
1982 task->tk_pid, __func__, status);
1986 static const struct rpc_authops authgss_ops = {
1987 .owner = THIS_MODULE,
1988 .au_flavor = RPC_AUTH_GSS,
1989 .au_name = "RPCSEC_GSS",
1990 .create = gss_create,
1991 .destroy = gss_destroy,
1992 .hash_cred = gss_hash_cred,
1993 .lookup_cred = gss_lookup_cred,
1994 .crcreate = gss_create_cred,
1995 .list_pseudoflavors = gss_mech_list_pseudoflavors,
1996 .info2flavor = gss_mech_info2flavor,
1997 .flavor2info = gss_mech_flavor2info,
2000 static const struct rpc_credops gss_credops = {
2001 .cr_name = "AUTH_GSS",
2002 .crdestroy = gss_destroy_cred,
2003 .cr_init = gss_cred_init,
2004 .crbind = rpcauth_generic_bind_cred,
2005 .crmatch = gss_match,
2006 .crmarshal = gss_marshal,
2007 .crrefresh = gss_refresh,
2008 .crvalidate = gss_validate,
2009 .crwrap_req = gss_wrap_req,
2010 .crunwrap_resp = gss_unwrap_resp,
2011 .crkey_timeout = gss_key_timeout,
2012 .crstringify_acceptor = gss_stringify_acceptor,
2015 static const struct rpc_credops gss_nullops = {
2016 .cr_name = "AUTH_GSS",
2017 .crdestroy = gss_destroy_nullcred,
2018 .crbind = rpcauth_generic_bind_cred,
2019 .crmatch = gss_match,
2020 .crmarshal = gss_marshal,
2021 .crrefresh = gss_refresh_null,
2022 .crvalidate = gss_validate,
2023 .crwrap_req = gss_wrap_req,
2024 .crunwrap_resp = gss_unwrap_resp,
2025 .crstringify_acceptor = gss_stringify_acceptor,
2028 static const struct rpc_pipe_ops gss_upcall_ops_v0 = {
2029 .upcall = rpc_pipe_generic_upcall,
2030 .downcall = gss_pipe_downcall,
2031 .destroy_msg = gss_pipe_destroy_msg,
2032 .open_pipe = gss_pipe_open_v0,
2033 .release_pipe = gss_pipe_release,
2036 static const struct rpc_pipe_ops gss_upcall_ops_v1 = {
2037 .upcall = rpc_pipe_generic_upcall,
2038 .downcall = gss_pipe_downcall,
2039 .destroy_msg = gss_pipe_destroy_msg,
2040 .open_pipe = gss_pipe_open_v1,
2041 .release_pipe = gss_pipe_release,
2044 static __net_init int rpcsec_gss_init_net(struct net *net)
2046 return gss_svc_init_net(net);
2049 static __net_exit void rpcsec_gss_exit_net(struct net *net)
2051 gss_svc_shutdown_net(net);
2054 static struct pernet_operations rpcsec_gss_net_ops = {
2055 .init = rpcsec_gss_init_net,
2056 .exit = rpcsec_gss_exit_net,
2060 * Initialize RPCSEC_GSS module
2062 static int __init init_rpcsec_gss(void)
2066 err = rpcauth_register(&authgss_ops);
2069 err = gss_svc_init();
2071 goto out_unregister;
2072 err = register_pernet_subsys(&rpcsec_gss_net_ops);
2075 rpc_init_wait_queue(&pipe_version_rpc_waitqueue, "gss pipe version");
2080 rpcauth_unregister(&authgss_ops);
2085 static void __exit exit_rpcsec_gss(void)
2087 unregister_pernet_subsys(&rpcsec_gss_net_ops);
2089 rpcauth_unregister(&authgss_ops);
2090 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2093 MODULE_ALIAS("rpc-auth-6");
2094 MODULE_LICENSE("GPL");
2095 module_param_named(expired_cred_retry_delay,
2096 gss_expired_cred_retry_delay,
2098 MODULE_PARM_DESC(expired_cred_retry_delay, "Timeout (in seconds) until "
2099 "the RPC engine retries an expired credential");
2101 module_param_named(key_expire_timeo,
2102 gss_key_expire_timeo,
2104 MODULE_PARM_DESC(key_expire_timeo, "Time (in seconds) at the end of a "
2105 "credential keys lifetime where the NFS layer cleans up "
2106 "prior to key expiration");
2108 module_init(init_rpcsec_gss)
2109 module_exit(exit_rpcsec_gss)