1 // SPDX-License-Identifier: BSD-3-Clause
3 * linux/net/sunrpc/auth_gss/auth_gss.c
5 * RPCSEC_GSS client authentication.
7 * Copyright (c) 2000 The Regents of the University of Michigan.
10 * Dug Song <dugsong@monkey.org>
11 * Andy Adamson <andros@umich.edu>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/types.h>
17 #include <linux/slab.h>
18 #include <linux/sched.h>
19 #include <linux/pagemap.h>
20 #include <linux/sunrpc/clnt.h>
21 #include <linux/sunrpc/auth.h>
22 #include <linux/sunrpc/auth_gss.h>
23 #include <linux/sunrpc/svcauth_gss.h>
24 #include <linux/sunrpc/gss_err.h>
25 #include <linux/workqueue.h>
26 #include <linux/sunrpc/rpc_pipe_fs.h>
27 #include <linux/sunrpc/gss_api.h>
28 #include <linux/uaccess.h>
29 #include <linux/hashtable.h>
33 #include <trace/events/rpcgss.h>
35 static const struct rpc_authops authgss_ops;
37 static const struct rpc_credops gss_credops;
38 static const struct rpc_credops gss_nullops;
40 #define GSS_RETRY_EXPIRED 5
41 static unsigned int gss_expired_cred_retry_delay = GSS_RETRY_EXPIRED;
43 #define GSS_KEY_EXPIRE_TIMEO 240
44 static unsigned int gss_key_expire_timeo = GSS_KEY_EXPIRE_TIMEO;
46 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
47 # define RPCDBG_FACILITY RPCDBG_AUTH
50 #define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
51 /* length of a krb5 verifier (48), plus data added before arguments when
52 * using integrity (two 4-byte integers): */
53 #define GSS_VERF_SLACK 100
55 static DEFINE_HASHTABLE(gss_auth_hash_table, 4);
56 static DEFINE_SPINLOCK(gss_auth_hash_lock);
59 struct rpc_pipe_dir_object pdo;
60 struct rpc_pipe *pipe;
61 struct rpc_clnt *clnt;
68 struct hlist_node hash;
69 struct rpc_auth rpc_auth;
70 struct gss_api_mech *mech;
71 enum rpc_gss_svc service;
72 struct rpc_clnt *client;
75 * There are two upcall pipes; dentry[1], named "gssd", is used
76 * for the new text-based upcall; dentry[0] is named after the
77 * mechanism (for example, "krb5") and exists for
78 * backwards-compatibility with older gssd's.
80 struct gss_pipe *gss_pipe[2];
81 const char *target_name;
84 /* pipe_version >= 0 if and only if someone has a pipe open. */
85 static DEFINE_SPINLOCK(pipe_version_lock);
86 static struct rpc_wait_queue pipe_version_rpc_waitqueue;
87 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue);
88 static void gss_put_auth(struct gss_auth *gss_auth);
90 static void gss_free_ctx(struct gss_cl_ctx *);
91 static const struct rpc_pipe_ops gss_upcall_ops_v0;
92 static const struct rpc_pipe_ops gss_upcall_ops_v1;
94 static inline struct gss_cl_ctx *
95 gss_get_ctx(struct gss_cl_ctx *ctx)
97 refcount_inc(&ctx->count);
102 gss_put_ctx(struct gss_cl_ctx *ctx)
104 if (refcount_dec_and_test(&ctx->count))
109 * called by gss_upcall_callback and gss_create_upcall in order
110 * to set the gss context. The actual exchange of an old context
111 * and a new one is protected by the pipe->lock.
114 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
116 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
118 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
121 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
122 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
123 smp_mb__before_atomic();
124 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
128 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
130 const void *q = (const void *)((const char *)p + len);
131 if (unlikely(q > end || q < p))
132 return ERR_PTR(-EFAULT);
137 static inline const void *
138 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
143 p = simple_get_bytes(p, end, &len, sizeof(len));
146 q = (const void *)((const char *)p + len);
147 if (unlikely(q > end || q < p))
148 return ERR_PTR(-EFAULT);
149 dest->data = kmemdup(p, len, GFP_NOFS);
150 if (unlikely(dest->data == NULL))
151 return ERR_PTR(-ENOMEM);
156 static struct gss_cl_ctx *
157 gss_cred_get_ctx(struct rpc_cred *cred)
159 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
160 struct gss_cl_ctx *ctx = NULL;
163 ctx = rcu_dereference(gss_cred->gc_ctx);
170 static struct gss_cl_ctx *
171 gss_alloc_context(void)
173 struct gss_cl_ctx *ctx;
175 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
177 ctx->gc_proc = RPC_GSS_PROC_DATA;
178 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
179 spin_lock_init(&ctx->gc_seq_lock);
180 refcount_set(&ctx->count,1);
185 #define GSSD_MIN_TIMEOUT (60 * 60)
187 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
191 unsigned int timeout;
192 unsigned long now = jiffies;
196 /* First unsigned int gives the remaining lifetime in seconds of the
197 * credential - e.g. the remaining TGT lifetime for Kerberos or
198 * the -t value passed to GSSD.
200 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
204 timeout = GSSD_MIN_TIMEOUT;
205 ctx->gc_expiry = now + ((unsigned long)timeout * HZ);
206 /* Sequence number window. Determines the maximum number of
207 * simultaneous requests
209 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
212 ctx->gc_win = window_size;
213 /* gssd signals an error by passing ctx->gc_win = 0: */
214 if (ctx->gc_win == 0) {
216 * in which case, p points to an error code. Anything other
217 * than -EKEYEXPIRED gets converted to -EACCES.
219 p = simple_get_bytes(p, end, &ret, sizeof(ret));
221 p = (ret == -EKEYEXPIRED) ? ERR_PTR(-EKEYEXPIRED) :
225 /* copy the opaque wire context */
226 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
229 /* import the opaque security context */
230 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
233 q = (const void *)((const char *)p + seclen);
234 if (unlikely(q > end || q < p)) {
235 p = ERR_PTR(-EFAULT);
238 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx, NULL, GFP_NOFS);
240 trace_rpcgss_import_ctx(ret);
245 /* is there any trailing data? */
251 /* pull in acceptor name (if there is one) */
252 p = simple_get_netobj(q, end, &ctx->gc_acceptor);
256 trace_rpcgss_context(ctx->gc_expiry, now, timeout,
257 ctx->gc_acceptor.len, ctx->gc_acceptor.data);
262 /* XXX: Need some documentation about why UPCALL_BUF_LEN is so small.
263 * Is user space expecting no more than UPCALL_BUF_LEN bytes?
264 * Note that there are now _two_ NI_MAXHOST sized data items
265 * being passed in this string.
267 #define UPCALL_BUF_LEN 256
269 struct gss_upcall_msg {
272 struct rpc_pipe_msg msg;
273 struct list_head list;
274 struct gss_auth *auth;
275 struct rpc_pipe *pipe;
276 struct rpc_wait_queue rpc_waitqueue;
277 wait_queue_head_t waitqueue;
278 struct gss_cl_ctx *ctx;
279 char databuf[UPCALL_BUF_LEN];
282 static int get_pipe_version(struct net *net)
284 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
287 spin_lock(&pipe_version_lock);
288 if (sn->pipe_version >= 0) {
289 atomic_inc(&sn->pipe_users);
290 ret = sn->pipe_version;
293 spin_unlock(&pipe_version_lock);
297 static void put_pipe_version(struct net *net)
299 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
301 if (atomic_dec_and_lock(&sn->pipe_users, &pipe_version_lock)) {
302 sn->pipe_version = -1;
303 spin_unlock(&pipe_version_lock);
308 gss_release_msg(struct gss_upcall_msg *gss_msg)
310 struct net *net = gss_msg->auth->net;
311 if (!refcount_dec_and_test(&gss_msg->count))
313 put_pipe_version(net);
314 BUG_ON(!list_empty(&gss_msg->list));
315 if (gss_msg->ctx != NULL)
316 gss_put_ctx(gss_msg->ctx);
317 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
318 gss_put_auth(gss_msg->auth);
322 static struct gss_upcall_msg *
323 __gss_find_upcall(struct rpc_pipe *pipe, kuid_t uid, const struct gss_auth *auth)
325 struct gss_upcall_msg *pos;
326 list_for_each_entry(pos, &pipe->in_downcall, list) {
327 if (!uid_eq(pos->uid, uid))
329 if (auth && pos->auth->service != auth->service)
331 refcount_inc(&pos->count);
337 /* Try to add an upcall to the pipefs queue.
338 * If an upcall owned by our uid already exists, then we return a reference
339 * to that upcall instead of adding the new upcall.
341 static inline struct gss_upcall_msg *
342 gss_add_msg(struct gss_upcall_msg *gss_msg)
344 struct rpc_pipe *pipe = gss_msg->pipe;
345 struct gss_upcall_msg *old;
347 spin_lock(&pipe->lock);
348 old = __gss_find_upcall(pipe, gss_msg->uid, gss_msg->auth);
350 refcount_inc(&gss_msg->count);
351 list_add(&gss_msg->list, &pipe->in_downcall);
354 spin_unlock(&pipe->lock);
359 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
361 list_del_init(&gss_msg->list);
362 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
363 wake_up_all(&gss_msg->waitqueue);
364 refcount_dec(&gss_msg->count);
368 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
370 struct rpc_pipe *pipe = gss_msg->pipe;
372 if (list_empty(&gss_msg->list))
374 spin_lock(&pipe->lock);
375 if (!list_empty(&gss_msg->list))
376 __gss_unhash_msg(gss_msg);
377 spin_unlock(&pipe->lock);
381 gss_handle_downcall_result(struct gss_cred *gss_cred, struct gss_upcall_msg *gss_msg)
383 switch (gss_msg->msg.errno) {
385 if (gss_msg->ctx == NULL)
387 clear_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
388 gss_cred_set_ctx(&gss_cred->gc_base, gss_msg->ctx);
391 set_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
393 gss_cred->gc_upcall_timestamp = jiffies;
394 gss_cred->gc_upcall = NULL;
395 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
399 gss_upcall_callback(struct rpc_task *task)
401 struct gss_cred *gss_cred = container_of(task->tk_rqstp->rq_cred,
402 struct gss_cred, gc_base);
403 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
404 struct rpc_pipe *pipe = gss_msg->pipe;
406 spin_lock(&pipe->lock);
407 gss_handle_downcall_result(gss_cred, gss_msg);
408 spin_unlock(&pipe->lock);
409 task->tk_status = gss_msg->msg.errno;
410 gss_release_msg(gss_msg);
413 static void gss_encode_v0_msg(struct gss_upcall_msg *gss_msg)
415 uid_t uid = from_kuid(&init_user_ns, gss_msg->uid);
416 memcpy(gss_msg->databuf, &uid, sizeof(uid));
417 gss_msg->msg.data = gss_msg->databuf;
418 gss_msg->msg.len = sizeof(uid);
420 BUILD_BUG_ON(sizeof(uid) > sizeof(gss_msg->databuf));
423 static int gss_encode_v1_msg(struct gss_upcall_msg *gss_msg,
424 const char *service_name,
425 const char *target_name)
427 struct gss_api_mech *mech = gss_msg->auth->mech;
428 char *p = gss_msg->databuf;
429 size_t buflen = sizeof(gss_msg->databuf);
432 len = scnprintf(p, buflen, "mech=%s uid=%d", mech->gm_name,
433 from_kuid(&init_user_ns, gss_msg->uid));
436 gss_msg->msg.len = len;
439 * target= is a full service principal that names the remote
440 * identity that we are authenticating to.
443 len = scnprintf(p, buflen, " target=%s", target_name);
446 gss_msg->msg.len += len;
450 * gssd uses service= and srchost= to select a matching key from
451 * the system's keytab to use as the source principal.
453 * service= is the service name part of the source principal,
454 * or "*" (meaning choose any).
456 * srchost= is the hostname part of the source principal. When
457 * not provided, gssd uses the local hostname.
460 char *c = strchr(service_name, '@');
463 len = scnprintf(p, buflen, " service=%s",
466 len = scnprintf(p, buflen,
467 " service=%.*s srchost=%s",
468 (int)(c - service_name),
469 service_name, c + 1);
472 gss_msg->msg.len += len;
475 if (mech->gm_upcall_enctypes) {
476 len = scnprintf(p, buflen, " enctypes=%s",
477 mech->gm_upcall_enctypes);
480 gss_msg->msg.len += len;
482 trace_rpcgss_upcall_msg(gss_msg->databuf);
483 len = scnprintf(p, buflen, "\n");
486 gss_msg->msg.len += len;
487 gss_msg->msg.data = gss_msg->databuf;
494 static struct gss_upcall_msg *
495 gss_alloc_msg(struct gss_auth *gss_auth,
496 kuid_t uid, const char *service_name)
498 struct gss_upcall_msg *gss_msg;
502 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
505 vers = get_pipe_version(gss_auth->net);
509 gss_msg->pipe = gss_auth->gss_pipe[vers]->pipe;
510 INIT_LIST_HEAD(&gss_msg->list);
511 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
512 init_waitqueue_head(&gss_msg->waitqueue);
513 refcount_set(&gss_msg->count, 1);
515 gss_msg->auth = gss_auth;
518 gss_encode_v0_msg(gss_msg);
521 err = gss_encode_v1_msg(gss_msg, service_name, gss_auth->target_name);
523 goto err_put_pipe_version;
525 kref_get(&gss_auth->kref);
527 err_put_pipe_version:
528 put_pipe_version(gss_auth->net);
535 static struct gss_upcall_msg *
536 gss_setup_upcall(struct gss_auth *gss_auth, struct rpc_cred *cred)
538 struct gss_cred *gss_cred = container_of(cred,
539 struct gss_cred, gc_base);
540 struct gss_upcall_msg *gss_new, *gss_msg;
541 kuid_t uid = cred->cr_cred->fsuid;
543 gss_new = gss_alloc_msg(gss_auth, uid, gss_cred->gc_principal);
546 gss_msg = gss_add_msg(gss_new);
547 if (gss_msg == gss_new) {
549 refcount_inc(&gss_msg->count);
550 res = rpc_queue_upcall(gss_new->pipe, &gss_new->msg);
552 gss_unhash_msg(gss_new);
553 refcount_dec(&gss_msg->count);
554 gss_release_msg(gss_new);
555 gss_msg = ERR_PTR(res);
558 gss_release_msg(gss_new);
562 static void warn_gssd(void)
564 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
568 gss_refresh_upcall(struct rpc_task *task)
570 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
571 struct gss_auth *gss_auth = container_of(cred->cr_auth,
572 struct gss_auth, rpc_auth);
573 struct gss_cred *gss_cred = container_of(cred,
574 struct gss_cred, gc_base);
575 struct gss_upcall_msg *gss_msg;
576 struct rpc_pipe *pipe;
579 gss_msg = gss_setup_upcall(gss_auth, cred);
580 if (PTR_ERR(gss_msg) == -EAGAIN) {
581 /* XXX: warning on the first, under the assumption we
582 * shouldn't normally hit this case on a refresh. */
584 task->tk_timeout = 15*HZ;
585 rpc_sleep_on(&pipe_version_rpc_waitqueue, task, NULL);
589 if (IS_ERR(gss_msg)) {
590 err = PTR_ERR(gss_msg);
593 pipe = gss_msg->pipe;
594 spin_lock(&pipe->lock);
595 if (gss_cred->gc_upcall != NULL)
596 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
597 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
598 task->tk_timeout = 0;
599 gss_cred->gc_upcall = gss_msg;
600 /* gss_upcall_callback will release the reference to gss_upcall_msg */
601 refcount_inc(&gss_msg->count);
602 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
604 gss_handle_downcall_result(gss_cred, gss_msg);
605 err = gss_msg->msg.errno;
607 spin_unlock(&pipe->lock);
608 gss_release_msg(gss_msg);
610 trace_rpcgss_upcall_result(from_kuid(&init_user_ns,
611 cred->cr_cred->fsuid), err);
616 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
618 struct net *net = gss_auth->net;
619 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
620 struct rpc_pipe *pipe;
621 struct rpc_cred *cred = &gss_cred->gc_base;
622 struct gss_upcall_msg *gss_msg;
628 /* if gssd is down, just skip upcalling altogether */
629 if (!gssd_running(net)) {
634 gss_msg = gss_setup_upcall(gss_auth, cred);
635 if (PTR_ERR(gss_msg) == -EAGAIN) {
636 err = wait_event_interruptible_timeout(pipe_version_waitqueue,
637 sn->pipe_version >= 0, 15 * HZ);
638 if (sn->pipe_version < 0) {
646 if (IS_ERR(gss_msg)) {
647 err = PTR_ERR(gss_msg);
650 pipe = gss_msg->pipe;
652 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_KILLABLE);
653 spin_lock(&pipe->lock);
654 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
657 spin_unlock(&pipe->lock);
658 if (fatal_signal_pending(current)) {
665 gss_cred_set_ctx(cred, gss_msg->ctx);
667 err = gss_msg->msg.errno;
668 spin_unlock(&pipe->lock);
670 finish_wait(&gss_msg->waitqueue, &wait);
671 gss_release_msg(gss_msg);
673 trace_rpcgss_upcall_result(from_kuid(&init_user_ns,
674 cred->cr_cred->fsuid), err);
678 #define MSG_BUF_MAXSIZE 1024
681 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
685 struct gss_upcall_msg *gss_msg;
686 struct rpc_pipe *pipe = RPC_I(file_inode(filp))->pipe;
687 struct gss_cl_ctx *ctx;
690 ssize_t err = -EFBIG;
692 if (mlen > MSG_BUF_MAXSIZE)
695 buf = kmalloc(mlen, GFP_NOFS);
700 if (copy_from_user(buf, src, mlen))
703 end = (const void *)((char *)buf + mlen);
704 p = simple_get_bytes(buf, end, &id, sizeof(id));
710 uid = make_kuid(&init_user_ns, id);
711 if (!uid_valid(uid)) {
717 ctx = gss_alloc_context();
722 /* Find a matching upcall */
723 spin_lock(&pipe->lock);
724 gss_msg = __gss_find_upcall(pipe, uid, NULL);
725 if (gss_msg == NULL) {
726 spin_unlock(&pipe->lock);
729 list_del_init(&gss_msg->list);
730 spin_unlock(&pipe->lock);
732 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
738 gss_msg->msg.errno = err;
745 gss_msg->msg.errno = -EAGAIN;
748 printk(KERN_CRIT "%s: bad return from "
749 "gss_fill_context: %zd\n", __func__, err);
750 gss_msg->msg.errno = -EIO;
752 goto err_release_msg;
754 gss_msg->ctx = gss_get_ctx(ctx);
758 spin_lock(&pipe->lock);
759 __gss_unhash_msg(gss_msg);
760 spin_unlock(&pipe->lock);
761 gss_release_msg(gss_msg);
770 static int gss_pipe_open(struct inode *inode, int new_version)
772 struct net *net = inode->i_sb->s_fs_info;
773 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
776 spin_lock(&pipe_version_lock);
777 if (sn->pipe_version < 0) {
778 /* First open of any gss pipe determines the version: */
779 sn->pipe_version = new_version;
780 rpc_wake_up(&pipe_version_rpc_waitqueue);
781 wake_up(&pipe_version_waitqueue);
782 } else if (sn->pipe_version != new_version) {
783 /* Trying to open a pipe of a different version */
787 atomic_inc(&sn->pipe_users);
789 spin_unlock(&pipe_version_lock);
794 static int gss_pipe_open_v0(struct inode *inode)
796 return gss_pipe_open(inode, 0);
799 static int gss_pipe_open_v1(struct inode *inode)
801 return gss_pipe_open(inode, 1);
805 gss_pipe_release(struct inode *inode)
807 struct net *net = inode->i_sb->s_fs_info;
808 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
809 struct gss_upcall_msg *gss_msg;
812 spin_lock(&pipe->lock);
813 list_for_each_entry(gss_msg, &pipe->in_downcall, list) {
815 if (!list_empty(&gss_msg->msg.list))
817 gss_msg->msg.errno = -EPIPE;
818 refcount_inc(&gss_msg->count);
819 __gss_unhash_msg(gss_msg);
820 spin_unlock(&pipe->lock);
821 gss_release_msg(gss_msg);
824 spin_unlock(&pipe->lock);
826 put_pipe_version(net);
830 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
832 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
834 if (msg->errno < 0) {
835 refcount_inc(&gss_msg->count);
836 gss_unhash_msg(gss_msg);
837 if (msg->errno == -ETIMEDOUT)
839 gss_release_msg(gss_msg);
841 gss_release_msg(gss_msg);
844 static void gss_pipe_dentry_destroy(struct dentry *dir,
845 struct rpc_pipe_dir_object *pdo)
847 struct gss_pipe *gss_pipe = pdo->pdo_data;
848 struct rpc_pipe *pipe = gss_pipe->pipe;
850 if (pipe->dentry != NULL) {
851 rpc_unlink(pipe->dentry);
856 static int gss_pipe_dentry_create(struct dentry *dir,
857 struct rpc_pipe_dir_object *pdo)
859 struct gss_pipe *p = pdo->pdo_data;
860 struct dentry *dentry;
862 dentry = rpc_mkpipe_dentry(dir, p->name, p->clnt, p->pipe);
864 return PTR_ERR(dentry);
865 p->pipe->dentry = dentry;
869 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops = {
870 .create = gss_pipe_dentry_create,
871 .destroy = gss_pipe_dentry_destroy,
874 static struct gss_pipe *gss_pipe_alloc(struct rpc_clnt *clnt,
876 const struct rpc_pipe_ops *upcall_ops)
881 p = kmalloc(sizeof(*p), GFP_KERNEL);
884 p->pipe = rpc_mkpipe_data(upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
885 if (IS_ERR(p->pipe)) {
886 err = PTR_ERR(p->pipe);
887 goto err_free_gss_pipe;
892 rpc_init_pipe_dir_object(&p->pdo,
893 &gss_pipe_dir_object_ops,
902 struct gss_alloc_pdo {
903 struct rpc_clnt *clnt;
905 const struct rpc_pipe_ops *upcall_ops;
908 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object *pdo, void *data)
910 struct gss_pipe *gss_pipe;
911 struct gss_alloc_pdo *args = data;
913 if (pdo->pdo_ops != &gss_pipe_dir_object_ops)
915 gss_pipe = container_of(pdo, struct gss_pipe, pdo);
916 if (strcmp(gss_pipe->name, args->name) != 0)
918 if (!kref_get_unless_zero(&gss_pipe->kref))
923 static struct rpc_pipe_dir_object *gss_pipe_alloc_pdo(void *data)
925 struct gss_pipe *gss_pipe;
926 struct gss_alloc_pdo *args = data;
928 gss_pipe = gss_pipe_alloc(args->clnt, args->name, args->upcall_ops);
929 if (!IS_ERR(gss_pipe))
930 return &gss_pipe->pdo;
934 static struct gss_pipe *gss_pipe_get(struct rpc_clnt *clnt,
936 const struct rpc_pipe_ops *upcall_ops)
938 struct net *net = rpc_net_ns(clnt);
939 struct rpc_pipe_dir_object *pdo;
940 struct gss_alloc_pdo args = {
943 .upcall_ops = upcall_ops,
946 pdo = rpc_find_or_alloc_pipe_dir_object(net,
947 &clnt->cl_pipedir_objects,
952 return container_of(pdo, struct gss_pipe, pdo);
953 return ERR_PTR(-ENOMEM);
956 static void __gss_pipe_free(struct gss_pipe *p)
958 struct rpc_clnt *clnt = p->clnt;
959 struct net *net = rpc_net_ns(clnt);
961 rpc_remove_pipe_dir_object(net,
962 &clnt->cl_pipedir_objects,
964 rpc_destroy_pipe_data(p->pipe);
968 static void __gss_pipe_release(struct kref *kref)
970 struct gss_pipe *p = container_of(kref, struct gss_pipe, kref);
975 static void gss_pipe_free(struct gss_pipe *p)
978 kref_put(&p->kref, __gss_pipe_release);
982 * NOTE: we have the opportunity to use different
983 * parameters based on the input flavor (which must be a pseudoflavor)
985 static struct gss_auth *
986 gss_create_new(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
988 rpc_authflavor_t flavor = args->pseudoflavor;
989 struct gss_auth *gss_auth;
990 struct gss_pipe *gss_pipe;
991 struct rpc_auth * auth;
992 int err = -ENOMEM; /* XXX? */
994 if (!try_module_get(THIS_MODULE))
996 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
998 INIT_HLIST_NODE(&gss_auth->hash);
999 gss_auth->target_name = NULL;
1000 if (args->target_name) {
1001 gss_auth->target_name = kstrdup(args->target_name, GFP_KERNEL);
1002 if (gss_auth->target_name == NULL)
1005 gss_auth->client = clnt;
1006 gss_auth->net = get_net(rpc_net_ns(clnt));
1008 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
1009 if (!gss_auth->mech)
1011 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
1012 if (gss_auth->service == 0)
1014 if (!gssd_running(gss_auth->net))
1016 auth = &gss_auth->rpc_auth;
1017 auth->au_cslack = GSS_CRED_SLACK >> 2;
1018 auth->au_rslack = GSS_VERF_SLACK >> 2;
1019 auth->au_verfsize = GSS_VERF_SLACK >> 2;
1020 auth->au_ralign = GSS_VERF_SLACK >> 2;
1022 auth->au_ops = &authgss_ops;
1023 auth->au_flavor = flavor;
1024 if (gss_pseudoflavor_to_datatouch(gss_auth->mech, flavor))
1025 auth->au_flags |= RPCAUTH_AUTH_DATATOUCH;
1026 refcount_set(&auth->au_count, 1);
1027 kref_init(&gss_auth->kref);
1029 err = rpcauth_init_credcache(auth);
1033 * Note: if we created the old pipe first, then someone who
1034 * examined the directory at the right moment might conclude
1035 * that we supported only the old pipe. So we instead create
1036 * the new pipe first.
1038 gss_pipe = gss_pipe_get(clnt, "gssd", &gss_upcall_ops_v1);
1039 if (IS_ERR(gss_pipe)) {
1040 err = PTR_ERR(gss_pipe);
1041 goto err_destroy_credcache;
1043 gss_auth->gss_pipe[1] = gss_pipe;
1045 gss_pipe = gss_pipe_get(clnt, gss_auth->mech->gm_name,
1046 &gss_upcall_ops_v0);
1047 if (IS_ERR(gss_pipe)) {
1048 err = PTR_ERR(gss_pipe);
1049 goto err_destroy_pipe_1;
1051 gss_auth->gss_pipe[0] = gss_pipe;
1055 gss_pipe_free(gss_auth->gss_pipe[1]);
1056 err_destroy_credcache:
1057 rpcauth_destroy_credcache(auth);
1059 gss_mech_put(gss_auth->mech);
1061 put_net(gss_auth->net);
1063 kfree(gss_auth->target_name);
1066 module_put(THIS_MODULE);
1067 trace_rpcgss_createauth(flavor, err);
1068 return ERR_PTR(err);
1072 gss_free(struct gss_auth *gss_auth)
1074 gss_pipe_free(gss_auth->gss_pipe[0]);
1075 gss_pipe_free(gss_auth->gss_pipe[1]);
1076 gss_mech_put(gss_auth->mech);
1077 put_net(gss_auth->net);
1078 kfree(gss_auth->target_name);
1081 module_put(THIS_MODULE);
1085 gss_free_callback(struct kref *kref)
1087 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
1093 gss_put_auth(struct gss_auth *gss_auth)
1095 kref_put(&gss_auth->kref, gss_free_callback);
1099 gss_destroy(struct rpc_auth *auth)
1101 struct gss_auth *gss_auth = container_of(auth,
1102 struct gss_auth, rpc_auth);
1104 if (hash_hashed(&gss_auth->hash)) {
1105 spin_lock(&gss_auth_hash_lock);
1106 hash_del(&gss_auth->hash);
1107 spin_unlock(&gss_auth_hash_lock);
1110 gss_pipe_free(gss_auth->gss_pipe[0]);
1111 gss_auth->gss_pipe[0] = NULL;
1112 gss_pipe_free(gss_auth->gss_pipe[1]);
1113 gss_auth->gss_pipe[1] = NULL;
1114 rpcauth_destroy_credcache(auth);
1116 gss_put_auth(gss_auth);
1120 * Auths may be shared between rpc clients that were cloned from a
1121 * common client with the same xprt, if they also share the flavor and
1124 * The auth is looked up from the oldest parent sharing the same
1125 * cl_xprt, and the auth itself references only that common parent
1126 * (which is guaranteed to last as long as any of its descendants).
1128 static struct gss_auth *
1129 gss_auth_find_or_add_hashed(const struct rpc_auth_create_args *args,
1130 struct rpc_clnt *clnt,
1131 struct gss_auth *new)
1133 struct gss_auth *gss_auth;
1134 unsigned long hashval = (unsigned long)clnt;
1136 spin_lock(&gss_auth_hash_lock);
1137 hash_for_each_possible(gss_auth_hash_table,
1141 if (gss_auth->client != clnt)
1143 if (gss_auth->rpc_auth.au_flavor != args->pseudoflavor)
1145 if (gss_auth->target_name != args->target_name) {
1146 if (gss_auth->target_name == NULL)
1148 if (args->target_name == NULL)
1150 if (strcmp(gss_auth->target_name, args->target_name))
1153 if (!refcount_inc_not_zero(&gss_auth->rpc_auth.au_count))
1158 hash_add(gss_auth_hash_table, &new->hash, hashval);
1161 spin_unlock(&gss_auth_hash_lock);
1165 static struct gss_auth *
1166 gss_create_hashed(const struct rpc_auth_create_args *args,
1167 struct rpc_clnt *clnt)
1169 struct gss_auth *gss_auth;
1170 struct gss_auth *new;
1172 gss_auth = gss_auth_find_or_add_hashed(args, clnt, NULL);
1173 if (gss_auth != NULL)
1175 new = gss_create_new(args, clnt);
1178 gss_auth = gss_auth_find_or_add_hashed(args, clnt, new);
1179 if (gss_auth != new)
1180 gss_destroy(&new->rpc_auth);
1185 static struct rpc_auth *
1186 gss_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1188 struct gss_auth *gss_auth;
1189 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
1191 while (clnt != clnt->cl_parent) {
1192 struct rpc_clnt *parent = clnt->cl_parent;
1193 /* Find the original parent for this transport */
1194 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
1199 gss_auth = gss_create_hashed(args, clnt);
1200 if (IS_ERR(gss_auth))
1201 return ERR_CAST(gss_auth);
1202 return &gss_auth->rpc_auth;
1205 static struct gss_cred *
1206 gss_dup_cred(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
1208 struct gss_cred *new;
1210 /* Make a copy of the cred so that we can reference count it */
1211 new = kzalloc(sizeof(*gss_cred), GFP_NOFS);
1213 struct auth_cred acred = {
1214 .cred = gss_cred->gc_base.cr_cred,
1216 struct gss_cl_ctx *ctx =
1217 rcu_dereference_protected(gss_cred->gc_ctx, 1);
1219 rpcauth_init_cred(&new->gc_base, &acred,
1220 &gss_auth->rpc_auth,
1222 new->gc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
1223 new->gc_service = gss_cred->gc_service;
1224 new->gc_principal = gss_cred->gc_principal;
1225 kref_get(&gss_auth->kref);
1226 rcu_assign_pointer(new->gc_ctx, ctx);
1233 * gss_send_destroy_context will cause the RPCSEC_GSS to send a NULL RPC call
1234 * to the server with the GSS control procedure field set to
1235 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1236 * all RPCSEC_GSS state associated with that context.
1239 gss_send_destroy_context(struct rpc_cred *cred)
1241 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1242 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1243 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1244 struct gss_cred *new;
1245 struct rpc_task *task;
1247 new = gss_dup_cred(gss_auth, gss_cred);
1249 ctx->gc_proc = RPC_GSS_PROC_DESTROY;
1251 task = rpc_call_null(gss_auth->client, &new->gc_base,
1252 RPC_TASK_ASYNC|RPC_TASK_SOFT);
1256 put_rpccred(&new->gc_base);
1260 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1261 * to create a new cred or context, so they check that things have been
1262 * allocated before freeing them. */
1264 gss_do_free_ctx(struct gss_cl_ctx *ctx)
1266 gss_delete_sec_context(&ctx->gc_gss_ctx);
1267 kfree(ctx->gc_wire_ctx.data);
1268 kfree(ctx->gc_acceptor.data);
1273 gss_free_ctx_callback(struct rcu_head *head)
1275 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
1276 gss_do_free_ctx(ctx);
1280 gss_free_ctx(struct gss_cl_ctx *ctx)
1282 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
1286 gss_free_cred(struct gss_cred *gss_cred)
1292 gss_free_cred_callback(struct rcu_head *head)
1294 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
1295 gss_free_cred(gss_cred);
1299 gss_destroy_nullcred(struct rpc_cred *cred)
1301 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1302 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1303 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1305 RCU_INIT_POINTER(gss_cred->gc_ctx, NULL);
1306 put_cred(cred->cr_cred);
1307 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
1310 gss_put_auth(gss_auth);
1314 gss_destroy_cred(struct rpc_cred *cred)
1317 if (test_and_clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0)
1318 gss_send_destroy_context(cred);
1319 gss_destroy_nullcred(cred);
1323 gss_hash_cred(struct auth_cred *acred, unsigned int hashbits)
1325 return hash_64(from_kuid(&init_user_ns, acred->cred->fsuid), hashbits);
1329 * Lookup RPCSEC_GSS cred for the current process
1331 static struct rpc_cred *
1332 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1334 return rpcauth_lookup_credcache(auth, acred, flags, GFP_NOFS);
1337 static struct rpc_cred *
1338 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp)
1340 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1341 struct gss_cred *cred = NULL;
1344 if (!(cred = kzalloc(sizeof(*cred), gfp)))
1347 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
1349 * Note: in order to force a call to call_refresh(), we deliberately
1350 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1352 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
1353 cred->gc_service = gss_auth->service;
1354 cred->gc_principal = acred->principal;
1355 kref_get(&gss_auth->kref);
1356 return &cred->gc_base;
1359 return ERR_PTR(err);
1363 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
1365 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1366 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
1370 err = gss_create_upcall(gss_auth, gss_cred);
1371 } while (err == -EAGAIN);
1376 gss_stringify_acceptor(struct rpc_cred *cred)
1378 char *string = NULL;
1379 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1380 struct gss_cl_ctx *ctx;
1382 struct xdr_netobj *acceptor;
1385 ctx = rcu_dereference(gss_cred->gc_ctx);
1389 len = ctx->gc_acceptor.len;
1392 /* no point if there's no string */
1396 string = kmalloc(len + 1, GFP_KERNEL);
1401 ctx = rcu_dereference(gss_cred->gc_ctx);
1403 /* did the ctx disappear or was it replaced by one with no acceptor? */
1404 if (!ctx || !ctx->gc_acceptor.len) {
1410 acceptor = &ctx->gc_acceptor;
1413 * Did we find a new acceptor that's longer than the original? Allocate
1414 * a longer buffer and try again.
1416 if (len < acceptor->len) {
1417 len = acceptor->len;
1423 memcpy(string, acceptor->data, acceptor->len);
1424 string[acceptor->len] = '\0';
1431 * Returns -EACCES if GSS context is NULL or will expire within the
1432 * timeout (miliseconds)
1435 gss_key_timeout(struct rpc_cred *rc)
1437 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1438 struct gss_cl_ctx *ctx;
1439 unsigned long timeout = jiffies + (gss_key_expire_timeo * HZ);
1443 ctx = rcu_dereference(gss_cred->gc_ctx);
1444 if (!ctx || time_after(timeout, ctx->gc_expiry))
1452 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
1454 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1455 struct gss_cl_ctx *ctx;
1458 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
1460 /* Don't match with creds that have expired. */
1462 ctx = rcu_dereference(gss_cred->gc_ctx);
1463 if (!ctx || time_after(jiffies, ctx->gc_expiry)) {
1468 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
1471 if (acred->principal != NULL) {
1472 if (gss_cred->gc_principal == NULL)
1474 ret = strcmp(acred->principal, gss_cred->gc_principal) == 0;
1476 if (gss_cred->gc_principal != NULL)
1478 ret = uid_eq(rc->cr_cred->fsuid, acred->cred->fsuid);
1484 * Marshal credentials.
1486 * The expensive part is computing the verifier. We can't cache a
1487 * pre-computed version of the verifier because the seqno, which
1488 * is different every time, is included in the MIC.
1490 static int gss_marshal(struct rpc_task *task, struct xdr_stream *xdr)
1492 struct rpc_rqst *req = task->tk_rqstp;
1493 struct rpc_cred *cred = req->rq_cred;
1494 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1496 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1497 __be32 *p, *cred_len;
1499 struct xdr_netobj mic;
1501 struct xdr_buf verf_buf;
1506 p = xdr_reserve_space(xdr, 7 * sizeof(*p) +
1507 ctx->gc_wire_ctx.len);
1509 goto marshal_failed;
1510 *p++ = rpc_auth_gss;
1513 spin_lock(&ctx->gc_seq_lock);
1514 req->rq_seqno = (ctx->gc_seq < MAXSEQ) ? ctx->gc_seq++ : MAXSEQ;
1515 spin_unlock(&ctx->gc_seq_lock);
1516 if (req->rq_seqno == MAXSEQ)
1518 trace_rpcgss_seqno(task);
1520 *p++ = cpu_to_be32(RPC_GSS_VERSION);
1521 *p++ = cpu_to_be32(ctx->gc_proc);
1522 *p++ = cpu_to_be32(req->rq_seqno);
1523 *p++ = cpu_to_be32(gss_cred->gc_service);
1524 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
1525 *cred_len = cpu_to_be32((p - (cred_len + 1)) << 2);
1529 /* We compute the checksum for the verifier over the xdr-encoded bytes
1530 * starting with the xid and ending at the end of the credential: */
1531 iov.iov_base = req->rq_snd_buf.head[0].iov_base;
1532 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
1533 xdr_buf_from_iov(&iov, &verf_buf);
1535 p = xdr_reserve_space(xdr, sizeof(*p));
1537 goto marshal_failed;
1538 *p++ = rpc_auth_gss;
1539 mic.data = (u8 *)(p + 1);
1540 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1541 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1543 else if (maj_stat != 0)
1545 if (xdr_stream_encode_opaque_inline(xdr, (void **)&p, mic.len) < 0)
1546 goto marshal_failed;
1552 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1553 status = -EKEYEXPIRED;
1559 trace_rpcgss_get_mic(task, maj_stat);
1564 static int gss_renew_cred(struct rpc_task *task)
1566 struct rpc_cred *oldcred = task->tk_rqstp->rq_cred;
1567 struct gss_cred *gss_cred = container_of(oldcred,
1570 struct rpc_auth *auth = oldcred->cr_auth;
1571 struct auth_cred acred = {
1572 .cred = oldcred->cr_cred,
1573 .principal = gss_cred->gc_principal,
1575 struct rpc_cred *new;
1577 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
1579 return PTR_ERR(new);
1580 task->tk_rqstp->rq_cred = new;
1581 put_rpccred(oldcred);
1585 static int gss_cred_is_negative_entry(struct rpc_cred *cred)
1587 if (test_bit(RPCAUTH_CRED_NEGATIVE, &cred->cr_flags)) {
1588 unsigned long now = jiffies;
1589 unsigned long begin, expire;
1590 struct gss_cred *gss_cred;
1592 gss_cred = container_of(cred, struct gss_cred, gc_base);
1593 begin = gss_cred->gc_upcall_timestamp;
1594 expire = begin + gss_expired_cred_retry_delay * HZ;
1596 if (time_in_range_open(now, begin, expire))
1603 * Refresh credentials. XXX - finish
1606 gss_refresh(struct rpc_task *task)
1608 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1611 if (gss_cred_is_negative_entry(cred))
1612 return -EKEYEXPIRED;
1614 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
1615 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
1616 ret = gss_renew_cred(task);
1619 cred = task->tk_rqstp->rq_cred;
1622 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
1623 ret = gss_refresh_upcall(task);
1628 /* Dummy refresh routine: used only when destroying the context */
1630 gss_refresh_null(struct rpc_task *task)
1636 gss_validate(struct rpc_task *task, struct xdr_stream *xdr)
1638 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1639 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1640 __be32 *p, *seq = NULL;
1642 struct xdr_buf verf_buf;
1643 struct xdr_netobj mic;
1647 p = xdr_inline_decode(xdr, 2 * sizeof(*p));
1649 goto validate_failed;
1650 if (*p++ != rpc_auth_gss)
1651 goto validate_failed;
1652 len = be32_to_cpup(p);
1653 if (len > RPC_MAX_AUTH_SIZE)
1654 goto validate_failed;
1655 p = xdr_inline_decode(xdr, len);
1657 goto validate_failed;
1659 seq = kmalloc(4, GFP_NOFS);
1661 goto validate_failed;
1662 *seq = cpu_to_be32(task->tk_rqstp->rq_seqno);
1665 xdr_buf_from_iov(&iov, &verf_buf);
1668 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1669 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1670 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1674 /* We leave it to unwrap to calculate au_rslack. For now we just
1675 * calculate the length of the verifier: */
1676 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1687 trace_rpcgss_verify_mic(task, maj_stat);
1692 static int gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1693 struct rpc_task *task, struct xdr_stream *xdr)
1695 struct rpc_rqst *rqstp = task->tk_rqstp;
1696 struct xdr_buf integ_buf, *snd_buf = &rqstp->rq_snd_buf;
1697 struct xdr_netobj mic;
1698 __be32 *p, *integ_len;
1699 u32 offset, maj_stat;
1701 p = xdr_reserve_space(xdr, 2 * sizeof(*p));
1705 *p = cpu_to_be32(rqstp->rq_seqno);
1707 if (rpcauth_wrap_req_encode(task, xdr))
1710 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1711 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1712 offset, snd_buf->len - offset))
1714 *integ_len = cpu_to_be32(integ_buf.len);
1716 p = xdr_reserve_space(xdr, 0);
1719 mic.data = (u8 *)(p + 1);
1720 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1721 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1722 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1725 /* Check that the trailing MIC fit in the buffer, after the fact */
1726 if (xdr_stream_encode_opaque_inline(xdr, (void **)&p, mic.len) < 0)
1732 trace_rpcgss_get_mic(task, maj_stat);
1737 priv_release_snd_buf(struct rpc_rqst *rqstp)
1741 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1742 __free_page(rqstp->rq_enc_pages[i]);
1743 kfree(rqstp->rq_enc_pages);
1744 rqstp->rq_release_snd_buf = NULL;
1748 alloc_enc_pages(struct rpc_rqst *rqstp)
1750 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1753 if (rqstp->rq_release_snd_buf)
1754 rqstp->rq_release_snd_buf(rqstp);
1756 if (snd_buf->page_len == 0) {
1757 rqstp->rq_enc_pages_num = 0;
1761 first = snd_buf->page_base >> PAGE_SHIFT;
1762 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_SHIFT;
1763 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1765 = kmalloc_array(rqstp->rq_enc_pages_num,
1766 sizeof(struct page *),
1768 if (!rqstp->rq_enc_pages)
1770 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1771 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1772 if (rqstp->rq_enc_pages[i] == NULL)
1775 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1778 rqstp->rq_enc_pages_num = i;
1779 priv_release_snd_buf(rqstp);
1784 static int gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1785 struct rpc_task *task, struct xdr_stream *xdr)
1787 struct rpc_rqst *rqstp = task->tk_rqstp;
1788 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1789 u32 pad, offset, maj_stat;
1791 __be32 *p, *opaque_len;
1792 struct page **inpages;
1797 p = xdr_reserve_space(xdr, 2 * sizeof(*p));
1801 *p = cpu_to_be32(rqstp->rq_seqno);
1803 if (rpcauth_wrap_req_encode(task, xdr))
1806 status = alloc_enc_pages(rqstp);
1807 if (unlikely(status))
1809 first = snd_buf->page_base >> PAGE_SHIFT;
1810 inpages = snd_buf->pages + first;
1811 snd_buf->pages = rqstp->rq_enc_pages;
1812 snd_buf->page_base -= first << PAGE_SHIFT;
1814 * Move the tail into its own page, in case gss_wrap needs
1815 * more space in the head when wrapping.
1817 * Still... Why can't gss_wrap just slide the tail down?
1819 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1822 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1823 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1824 snd_buf->tail[0].iov_base = tmp;
1826 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1827 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1828 /* slack space should prevent this ever happening: */
1829 if (unlikely(snd_buf->len > snd_buf->buflen))
1831 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1832 * done anyway, so it's safe to put the request on the wire: */
1833 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1834 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1838 *opaque_len = cpu_to_be32(snd_buf->len - offset);
1839 /* guess whether the pad goes into the head or the tail: */
1840 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1841 iov = snd_buf->tail;
1843 iov = snd_buf->head;
1844 p = iov->iov_base + iov->iov_len;
1845 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1847 iov->iov_len += pad;
1848 snd_buf->len += pad;
1854 trace_rpcgss_wrap(task, maj_stat);
1858 static int gss_wrap_req(struct rpc_task *task, struct xdr_stream *xdr)
1860 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1861 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1863 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1867 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1868 /* The spec seems a little ambiguous here, but I think that not
1869 * wrapping context destruction requests makes the most sense.
1871 status = rpcauth_wrap_req_encode(task, xdr);
1874 switch (gss_cred->gc_service) {
1875 case RPC_GSS_SVC_NONE:
1876 status = rpcauth_wrap_req_encode(task, xdr);
1878 case RPC_GSS_SVC_INTEGRITY:
1879 status = gss_wrap_req_integ(cred, ctx, task, xdr);
1881 case RPC_GSS_SVC_PRIVACY:
1882 status = gss_wrap_req_priv(cred, ctx, task, xdr);
1893 gss_unwrap_resp_auth(struct rpc_cred *cred)
1895 struct rpc_auth *auth = cred->cr_auth;
1897 auth->au_rslack = auth->au_verfsize;
1898 auth->au_ralign = auth->au_verfsize;
1903 gss_unwrap_resp_integ(struct rpc_task *task, struct rpc_cred *cred,
1904 struct gss_cl_ctx *ctx, struct rpc_rqst *rqstp,
1905 struct xdr_stream *xdr)
1907 struct xdr_buf integ_buf, *rcv_buf = &rqstp->rq_rcv_buf;
1908 u32 data_offset, mic_offset, integ_len, maj_stat;
1909 struct rpc_auth *auth = cred->cr_auth;
1910 struct xdr_netobj mic;
1913 p = xdr_inline_decode(xdr, 2 * sizeof(*p));
1916 integ_len = be32_to_cpup(p++);
1919 data_offset = (u8 *)(p) - (u8 *)rcv_buf->head[0].iov_base;
1920 mic_offset = integ_len + data_offset;
1921 if (mic_offset > rcv_buf->len)
1923 if (be32_to_cpup(p) != rqstp->rq_seqno)
1926 if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset, integ_len))
1928 if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1930 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1931 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1932 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1933 if (maj_stat != GSS_S_COMPLETE)
1936 auth->au_rslack = auth->au_verfsize + 2 + 1 + XDR_QUADLEN(mic.len);
1937 auth->au_ralign = auth->au_verfsize + 2;
1940 trace_rpcgss_unwrap_failed(task);
1943 trace_rpcgss_bad_seqno(task, rqstp->rq_seqno, be32_to_cpup(p));
1946 trace_rpcgss_verify_mic(task, maj_stat);
1951 gss_unwrap_resp_priv(struct rpc_task *task, struct rpc_cred *cred,
1952 struct gss_cl_ctx *ctx, struct rpc_rqst *rqstp,
1953 struct xdr_stream *xdr)
1955 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
1956 struct kvec *head = rqstp->rq_rcv_buf.head;
1957 struct rpc_auth *auth = cred->cr_auth;
1958 unsigned int savedlen = rcv_buf->len;
1959 u32 offset, opaque_len, maj_stat;
1962 p = xdr_inline_decode(xdr, 2 * sizeof(*p));
1965 opaque_len = be32_to_cpup(p++);
1966 offset = (u8 *)(p) - (u8 *)head->iov_base;
1967 if (offset + opaque_len > rcv_buf->len)
1969 rcv_buf->len = offset + opaque_len;
1971 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1972 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1973 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1974 if (maj_stat != GSS_S_COMPLETE)
1976 /* gss_unwrap decrypted the sequence number */
1977 if (be32_to_cpup(p++) != rqstp->rq_seqno)
1980 /* gss_unwrap redacts the opaque blob from the head iovec.
1981 * rcv_buf has changed, thus the stream needs to be reset.
1983 xdr_init_decode(xdr, rcv_buf, p, rqstp);
1985 auth->au_rslack = auth->au_verfsize + 2 +
1986 XDR_QUADLEN(savedlen - rcv_buf->len);
1987 auth->au_ralign = auth->au_verfsize + 2 +
1988 XDR_QUADLEN(savedlen - rcv_buf->len);
1991 trace_rpcgss_unwrap_failed(task);
1994 trace_rpcgss_bad_seqno(task, rqstp->rq_seqno, be32_to_cpup(--p));
1997 trace_rpcgss_unwrap(task, maj_stat);
2002 gss_seq_is_newer(u32 new, u32 old)
2004 return (s32)(new - old) > 0;
2008 gss_xmit_need_reencode(struct rpc_task *task)
2010 struct rpc_rqst *req = task->tk_rqstp;
2011 struct rpc_cred *cred = req->rq_cred;
2012 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2013 u32 win, seq_xmit = 0;
2019 if (gss_seq_is_newer(req->rq_seqno, READ_ONCE(ctx->gc_seq)))
2022 seq_xmit = READ_ONCE(ctx->gc_seq_xmit);
2023 while (gss_seq_is_newer(req->rq_seqno, seq_xmit)) {
2026 seq_xmit = cmpxchg(&ctx->gc_seq_xmit, tmp, req->rq_seqno);
2027 if (seq_xmit == tmp) {
2035 ret = !gss_seq_is_newer(req->rq_seqno, seq_xmit - win);
2040 trace_rpcgss_need_reencode(task, seq_xmit, ret);
2045 gss_unwrap_resp(struct rpc_task *task, struct xdr_stream *xdr)
2047 struct rpc_rqst *rqstp = task->tk_rqstp;
2048 struct rpc_cred *cred = rqstp->rq_cred;
2049 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
2051 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2054 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
2056 switch (gss_cred->gc_service) {
2057 case RPC_GSS_SVC_NONE:
2058 status = gss_unwrap_resp_auth(cred);
2060 case RPC_GSS_SVC_INTEGRITY:
2061 status = gss_unwrap_resp_integ(task, cred, ctx, rqstp, xdr);
2063 case RPC_GSS_SVC_PRIVACY:
2064 status = gss_unwrap_resp_priv(task, cred, ctx, rqstp, xdr);
2071 status = rpcauth_unwrap_resp_decode(task, xdr);
2077 static const struct rpc_authops authgss_ops = {
2078 .owner = THIS_MODULE,
2079 .au_flavor = RPC_AUTH_GSS,
2080 .au_name = "RPCSEC_GSS",
2081 .create = gss_create,
2082 .destroy = gss_destroy,
2083 .hash_cred = gss_hash_cred,
2084 .lookup_cred = gss_lookup_cred,
2085 .crcreate = gss_create_cred,
2086 .list_pseudoflavors = gss_mech_list_pseudoflavors,
2087 .info2flavor = gss_mech_info2flavor,
2088 .flavor2info = gss_mech_flavor2info,
2091 static const struct rpc_credops gss_credops = {
2092 .cr_name = "AUTH_GSS",
2093 .crdestroy = gss_destroy_cred,
2094 .cr_init = gss_cred_init,
2095 .crmatch = gss_match,
2096 .crmarshal = gss_marshal,
2097 .crrefresh = gss_refresh,
2098 .crvalidate = gss_validate,
2099 .crwrap_req = gss_wrap_req,
2100 .crunwrap_resp = gss_unwrap_resp,
2101 .crkey_timeout = gss_key_timeout,
2102 .crstringify_acceptor = gss_stringify_acceptor,
2103 .crneed_reencode = gss_xmit_need_reencode,
2106 static const struct rpc_credops gss_nullops = {
2107 .cr_name = "AUTH_GSS",
2108 .crdestroy = gss_destroy_nullcred,
2109 .crmatch = gss_match,
2110 .crmarshal = gss_marshal,
2111 .crrefresh = gss_refresh_null,
2112 .crvalidate = gss_validate,
2113 .crwrap_req = gss_wrap_req,
2114 .crunwrap_resp = gss_unwrap_resp,
2115 .crstringify_acceptor = gss_stringify_acceptor,
2118 static const struct rpc_pipe_ops gss_upcall_ops_v0 = {
2119 .upcall = rpc_pipe_generic_upcall,
2120 .downcall = gss_pipe_downcall,
2121 .destroy_msg = gss_pipe_destroy_msg,
2122 .open_pipe = gss_pipe_open_v0,
2123 .release_pipe = gss_pipe_release,
2126 static const struct rpc_pipe_ops gss_upcall_ops_v1 = {
2127 .upcall = rpc_pipe_generic_upcall,
2128 .downcall = gss_pipe_downcall,
2129 .destroy_msg = gss_pipe_destroy_msg,
2130 .open_pipe = gss_pipe_open_v1,
2131 .release_pipe = gss_pipe_release,
2134 static __net_init int rpcsec_gss_init_net(struct net *net)
2136 return gss_svc_init_net(net);
2139 static __net_exit void rpcsec_gss_exit_net(struct net *net)
2141 gss_svc_shutdown_net(net);
2144 static struct pernet_operations rpcsec_gss_net_ops = {
2145 .init = rpcsec_gss_init_net,
2146 .exit = rpcsec_gss_exit_net,
2150 * Initialize RPCSEC_GSS module
2152 static int __init init_rpcsec_gss(void)
2156 err = rpcauth_register(&authgss_ops);
2159 err = gss_svc_init();
2161 goto out_unregister;
2162 err = register_pernet_subsys(&rpcsec_gss_net_ops);
2165 rpc_init_wait_queue(&pipe_version_rpc_waitqueue, "gss pipe version");
2170 rpcauth_unregister(&authgss_ops);
2175 static void __exit exit_rpcsec_gss(void)
2177 unregister_pernet_subsys(&rpcsec_gss_net_ops);
2179 rpcauth_unregister(&authgss_ops);
2180 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2183 MODULE_ALIAS("rpc-auth-6");
2184 MODULE_LICENSE("GPL");
2185 module_param_named(expired_cred_retry_delay,
2186 gss_expired_cred_retry_delay,
2188 MODULE_PARM_DESC(expired_cred_retry_delay, "Timeout (in seconds) until "
2189 "the RPC engine retries an expired credential");
2191 module_param_named(key_expire_timeo,
2192 gss_key_expire_timeo,
2194 MODULE_PARM_DESC(key_expire_timeo, "Time (in seconds) at the end of a "
2195 "credential keys lifetime where the NFS layer cleans up "
2196 "prior to key expiration");
2198 module_init(init_rpcsec_gss)
2199 module_exit(exit_rpcsec_gss)