net/sunrpc/auth_gss/auth_gss.c

   1 /*
   2  * linux/net/sunrpc/auth_gss/auth_gss.c
   3  *
   4  * RPCSEC_GSS client authentication.
   5  *
   6  *  Copyright (c) 2000 The Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  Dug Song       <dugsong@monkey.org>
  10  *  Andy Adamson   <andros@umich.edu>
  11  *
  12  *  Redistribution and use in source and binary forms, with or without
  13  *  modification, are permitted provided that the following conditions
  14  *  are met:
  15  *
  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.
  24  *
  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.
  36  */
  37
  38
  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>
  55
  56 #include "../netns.h"
  57
  58 static const struct rpc_authops authgss_ops;
  59
  60 static const struct rpc_credops gss_credops;
  61 static const struct rpc_credops gss_nullops;
  62
  63 #define GSS_RETRY_EXPIRED 5
  64 static unsigned int gss_expired_cred_retry_delay = GSS_RETRY_EXPIRED;
  65
  66 #define GSS_KEY_EXPIRE_TIMEO 240
  67 static unsigned int gss_key_expire_timeo = GSS_KEY_EXPIRE_TIMEO;
  68
  69 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  70 # define RPCDBG_FACILITY        RPCDBG_AUTH
  71 #endif
  72
  73 #define GSS_CRED_SLACK          (RPC_MAX_AUTH_SIZE * 2)
  74 /* length of a krb5 verifier (48), plus data added before arguments when
  75  * using integrity (two 4-byte integers): */
  76 #define GSS_VERF_SLACK          100
  77
  78 static DEFINE_HASHTABLE(gss_auth_hash_table, 4);
  79 static DEFINE_SPINLOCK(gss_auth_hash_lock);
  80
  81 struct gss_pipe {
  82         struct rpc_pipe_dir_object pdo;
  83         struct rpc_pipe *pipe;
  84         struct rpc_clnt *clnt;
  85         const char *name;
  86         struct kref kref;
  87 };
  88
  89 struct gss_auth {
  90         struct kref kref;
  91         struct hlist_node hash;
  92         struct rpc_auth rpc_auth;
  93         struct gss_api_mech *mech;
  94         enum rpc_gss_svc service;
  95         struct rpc_clnt *client;
  96         struct net *net;
  97         /*
  98          * There are two upcall pipes; dentry[1], named "gssd", is used
  99          * for the new text-based upcall; dentry[0] is named after the
 100          * mechanism (for example, "krb5") and exists for
 101          * backwards-compatibility with older gssd's.
 102          */
 103         struct gss_pipe *gss_pipe[2];
 104         const char *target_name;
 105 };
 106
 107 /* pipe_version >= 0 if and only if someone has a pipe open. */
 108 static DEFINE_SPINLOCK(pipe_version_lock);
 109 static struct rpc_wait_queue pipe_version_rpc_waitqueue;
 110 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue);
 111 static void gss_put_auth(struct gss_auth *gss_auth);
 112
 113 static void gss_free_ctx(struct gss_cl_ctx *);
 114 static const struct rpc_pipe_ops gss_upcall_ops_v0;
 115 static const struct rpc_pipe_ops gss_upcall_ops_v1;
 116
 117 static inline struct gss_cl_ctx *
 118 gss_get_ctx(struct gss_cl_ctx *ctx)
 119 {
 120         refcount_inc(&ctx->count);
 121         return ctx;
 122 }
 123
 124 static inline void
 125 gss_put_ctx(struct gss_cl_ctx *ctx)
 126 {
 127         if (refcount_dec_and_test(&ctx->count))
 128                 gss_free_ctx(ctx);
 129 }
 130
 131 /* gss_cred_set_ctx:
 132  * called by gss_upcall_callback and gss_create_upcall in order
 133  * to set the gss context. The actual exchange of an old context
 134  * and a new one is protected by the pipe->lock.
 135  */
 136 static void
 137 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
 138 {
 139         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
 140
 141         if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
 142                 return;
 143         gss_get_ctx(ctx);
 144         rcu_assign_pointer(gss_cred->gc_ctx, ctx);
 145         set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
 146         smp_mb__before_atomic();
 147         clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
 148 }
 149
 150 static const void *
 151 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
 152 {
 153         const void *q = (const void *)((const char *)p + len);
 154         if (unlikely(q > end || q < p))
 155                 return ERR_PTR(-EFAULT);
 156         memcpy(res, p, len);
 157         return q;
 158 }
 159
 160 static inline const void *
 161 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
 162 {
 163         const void *q;
 164         unsigned int len;
 165
 166         p = simple_get_bytes(p, end, &len, sizeof(len));
 167         if (IS_ERR(p))
 168                 return p;
 169         q = (const void *)((const char *)p + len);
 170         if (unlikely(q > end || q < p))
 171                 return ERR_PTR(-EFAULT);
 172         dest->data = kmemdup(p, len, GFP_NOFS);
 173         if (unlikely(dest->data == NULL))
 174                 return ERR_PTR(-ENOMEM);
 175         dest->len = len;
 176         return q;
 177 }
 178
 179 static struct gss_cl_ctx *
 180 gss_cred_get_ctx(struct rpc_cred *cred)
 181 {
 182         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
 183         struct gss_cl_ctx *ctx = NULL;
 184
 185         rcu_read_lock();
 186         ctx = rcu_dereference(gss_cred->gc_ctx);
 187         if (ctx)
 188                 gss_get_ctx(ctx);
 189         rcu_read_unlock();
 190         return ctx;
 191 }
 192
 193 static struct gss_cl_ctx *
 194 gss_alloc_context(void)
 195 {
 196         struct gss_cl_ctx *ctx;
 197
 198         ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
 199         if (ctx != NULL) {
 200                 ctx->gc_proc = RPC_GSS_PROC_DATA;
 201                 ctx->gc_seq = 1;        /* NetApp 6.4R1 doesn't accept seq. no. 0 */
 202                 spin_lock_init(&ctx->gc_seq_lock);
 203                 refcount_set(&ctx->count,1);
 204         }
 205         return ctx;
 206 }
 207
 208 #define GSSD_MIN_TIMEOUT (60 * 60)
 209 static const void *
 210 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
 211 {
 212         const void *q;
 213         unsigned int seclen;
 214         unsigned int timeout;
 215         unsigned long now = jiffies;
 216         u32 window_size;
 217         int ret;
 218
 219         /* First unsigned int gives the remaining lifetime in seconds of the
 220          * credential - e.g. the remaining TGT lifetime for Kerberos or
 221          * the -t value passed to GSSD.
 222          */
 223         p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
 224         if (IS_ERR(p))
 225                 goto err;
 226         if (timeout == 0)
 227                 timeout = GSSD_MIN_TIMEOUT;
 228         ctx->gc_expiry = now + ((unsigned long)timeout * HZ);
 229         /* Sequence number window. Determines the maximum number of
 230          * simultaneous requests
 231          */
 232         p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
 233         if (IS_ERR(p))
 234                 goto err;
 235         ctx->gc_win = window_size;
 236         /* gssd signals an error by passing ctx->gc_win = 0: */
 237         if (ctx->gc_win == 0) {
 238                 /*
 239                  * in which case, p points to an error code. Anything other
 240                  * than -EKEYEXPIRED gets converted to -EACCES.
 241                  */
 242                 p = simple_get_bytes(p, end, &ret, sizeof(ret));
 243                 if (!IS_ERR(p))
 244                         p = (ret == -EKEYEXPIRED) ? ERR_PTR(-EKEYEXPIRED) :
 245                                                     ERR_PTR(-EACCES);
 246                 goto err;
 247         }
 248         /* copy the opaque wire context */
 249         p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
 250         if (IS_ERR(p))
 251                 goto err;
 252         /* import the opaque security context */
 253         p  = simple_get_bytes(p, end, &seclen, sizeof(seclen));
 254         if (IS_ERR(p))
 255                 goto err;
 256         q = (const void *)((const char *)p + seclen);
 257         if (unlikely(q > end || q < p)) {
 258                 p = ERR_PTR(-EFAULT);
 259                 goto err;
 260         }
 261         ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx, NULL, GFP_NOFS);
 262         if (ret < 0) {
 263                 p = ERR_PTR(ret);
 264                 goto err;
 265         }
 266
 267         /* is there any trailing data? */
 268         if (q == end) {
 269                 p = q;
 270                 goto done;
 271         }
 272
 273         /* pull in acceptor name (if there is one) */
 274         p = simple_get_netobj(q, end, &ctx->gc_acceptor);
 275         if (IS_ERR(p))
 276                 goto err;
 277 done:
 278         dprintk("RPC:       %s Success. gc_expiry %lu now %lu timeout %u acceptor %.*s\n",
 279                 __func__, ctx->gc_expiry, now, timeout, ctx->gc_acceptor.len,
 280                 ctx->gc_acceptor.data);
 281         return p;
 282 err:
 283         dprintk("RPC:       %s returns error %ld\n", __func__, -PTR_ERR(p));
 284         return p;
 285 }
 286
 287 /* XXX: Need some documentation about why UPCALL_BUF_LEN is so small.
 288  *      Is user space expecting no more than UPCALL_BUF_LEN bytes?
 289  *      Note that there are now _two_ NI_MAXHOST sized data items
 290  *      being passed in this string.
 291  */
 292 #define UPCALL_BUF_LEN  256
 293
 294 struct gss_upcall_msg {
 295         refcount_t count;
 296         kuid_t  uid;
 297         struct rpc_pipe_msg msg;
 298         struct list_head list;
 299         struct gss_auth *auth;
 300         struct rpc_pipe *pipe;
 301         struct rpc_wait_queue rpc_waitqueue;
 302         wait_queue_head_t waitqueue;
 303         struct gss_cl_ctx *ctx;
 304         char databuf[UPCALL_BUF_LEN];
 305 };
 306
 307 static int get_pipe_version(struct net *net)
 308 {
 309         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 310         int ret;
 311
 312         spin_lock(&pipe_version_lock);
 313         if (sn->pipe_version >= 0) {
 314                 atomic_inc(&sn->pipe_users);
 315                 ret = sn->pipe_version;
 316         } else
 317                 ret = -EAGAIN;
 318         spin_unlock(&pipe_version_lock);
 319         return ret;
 320 }
 321
 322 static void put_pipe_version(struct net *net)
 323 {
 324         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 325
 326         if (atomic_dec_and_lock(&sn->pipe_users, &pipe_version_lock)) {
 327                 sn->pipe_version = -1;
 328                 spin_unlock(&pipe_version_lock);
 329         }
 330 }
 331
 332 static void
 333 gss_release_msg(struct gss_upcall_msg *gss_msg)
 334 {
 335         struct net *net = gss_msg->auth->net;
 336         if (!refcount_dec_and_test(&gss_msg->count))
 337                 return;
 338         put_pipe_version(net);
 339         BUG_ON(!list_empty(&gss_msg->list));
 340         if (gss_msg->ctx != NULL)
 341                 gss_put_ctx(gss_msg->ctx);
 342         rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
 343         gss_put_auth(gss_msg->auth);
 344         kfree(gss_msg);
 345 }
 346
 347 static struct gss_upcall_msg *
 348 __gss_find_upcall(struct rpc_pipe *pipe, kuid_t uid, const struct gss_auth *auth)
 349 {
 350         struct gss_upcall_msg *pos;
 351         list_for_each_entry(pos, &pipe->in_downcall, list) {
 352                 if (!uid_eq(pos->uid, uid))
 353                         continue;
 354                 if (auth && pos->auth->service != auth->service)
 355                         continue;
 356                 refcount_inc(&pos->count);
 357                 dprintk("RPC:       %s found msg %p\n", __func__, pos);
 358                 return pos;
 359         }
 360         dprintk("RPC:       %s found nothing\n", __func__);
 361         return NULL;
 362 }
 363
 364 /* Try to add an upcall to the pipefs queue.
 365  * If an upcall owned by our uid already exists, then we return a reference
 366  * to that upcall instead of adding the new upcall.
 367  */
 368 static inline struct gss_upcall_msg *
 369 gss_add_msg(struct gss_upcall_msg *gss_msg)
 370 {
 371         struct rpc_pipe *pipe = gss_msg->pipe;
 372         struct gss_upcall_msg *old;
 373
 374         spin_lock(&pipe->lock);
 375         old = __gss_find_upcall(pipe, gss_msg->uid, gss_msg->auth);
 376         if (old == NULL) {
 377                 refcount_inc(&gss_msg->count);
 378                 list_add(&gss_msg->list, &pipe->in_downcall);
 379         } else
 380                 gss_msg = old;
 381         spin_unlock(&pipe->lock);
 382         return gss_msg;
 383 }
 384
 385 static void
 386 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
 387 {
 388         list_del_init(&gss_msg->list);
 389         rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
 390         wake_up_all(&gss_msg->waitqueue);
 391         refcount_dec(&gss_msg->count);
 392 }
 393
 394 static void
 395 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
 396 {
 397         struct rpc_pipe *pipe = gss_msg->pipe;
 398
 399         if (list_empty(&gss_msg->list))
 400                 return;
 401         spin_lock(&pipe->lock);
 402         if (!list_empty(&gss_msg->list))
 403                 __gss_unhash_msg(gss_msg);
 404         spin_unlock(&pipe->lock);
 405 }
 406
 407 static void
 408 gss_handle_downcall_result(struct gss_cred *gss_cred, struct gss_upcall_msg *gss_msg)
 409 {
 410         switch (gss_msg->msg.errno) {
 411         case 0:
 412                 if (gss_msg->ctx == NULL)
 413                         break;
 414                 clear_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
 415                 gss_cred_set_ctx(&gss_cred->gc_base, gss_msg->ctx);
 416                 break;
 417         case -EKEYEXPIRED:
 418                 set_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
 419         }
 420         gss_cred->gc_upcall_timestamp = jiffies;
 421         gss_cred->gc_upcall = NULL;
 422         rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
 423 }
 424
 425 static void
 426 gss_upcall_callback(struct rpc_task *task)
 427 {
 428         struct gss_cred *gss_cred = container_of(task->tk_rqstp->rq_cred,
 429                         struct gss_cred, gc_base);
 430         struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
 431         struct rpc_pipe *pipe = gss_msg->pipe;
 432
 433         spin_lock(&pipe->lock);
 434         gss_handle_downcall_result(gss_cred, gss_msg);
 435         spin_unlock(&pipe->lock);
 436         task->tk_status = gss_msg->msg.errno;
 437         gss_release_msg(gss_msg);
 438 }
 439
 440 static void gss_encode_v0_msg(struct gss_upcall_msg *gss_msg)
 441 {
 442         uid_t uid = from_kuid(&init_user_ns, gss_msg->uid);
 443         memcpy(gss_msg->databuf, &uid, sizeof(uid));
 444         gss_msg->msg.data = gss_msg->databuf;
 445         gss_msg->msg.len = sizeof(uid);
 446
 447         BUILD_BUG_ON(sizeof(uid) > sizeof(gss_msg->databuf));
 448 }
 449
 450 static int gss_encode_v1_msg(struct gss_upcall_msg *gss_msg,
 451                                 const char *service_name,
 452                                 const char *target_name)
 453 {
 454         struct gss_api_mech *mech = gss_msg->auth->mech;
 455         char *p = gss_msg->databuf;
 456         size_t buflen = sizeof(gss_msg->databuf);
 457         int len;
 458
 459         len = scnprintf(p, buflen, "mech=%s uid=%d ", mech->gm_name,
 460                         from_kuid(&init_user_ns, gss_msg->uid));
 461         buflen -= len;
 462         p += len;
 463         gss_msg->msg.len = len;
 464
 465         /*
 466          * target= is a full service principal that names the remote
 467          * identity that we are authenticating to.
 468          */
 469         if (target_name) {
 470                 len = scnprintf(p, buflen, "target=%s ", target_name);
 471                 buflen -= len;
 472                 p += len;
 473                 gss_msg->msg.len += len;
 474         }
 475
 476         /*
 477          * gssd uses service= and srchost= to select a matching key from
 478          * the system's keytab to use as the source principal.
 479          *
 480          * service= is the service name part of the source principal,
 481          * or "*" (meaning choose any).
 482          *
 483          * srchost= is the hostname part of the source principal. When
 484          * not provided, gssd uses the local hostname.
 485          */
 486         if (service_name) {
 487                 char *c = strchr(service_name, '@');
 488
 489                 if (!c)
 490                         len = scnprintf(p, buflen, "service=%s ",
 491                                         service_name);
 492                 else
 493                         len = scnprintf(p, buflen,
 494                                         "service=%.*s srchost=%s ",
 495                                         (int)(c - service_name),
 496                                         service_name, c + 1);
 497                 buflen -= len;
 498                 p += len;
 499                 gss_msg->msg.len += len;
 500         }
 501
 502         if (mech->gm_upcall_enctypes) {
 503                 len = scnprintf(p, buflen, "enctypes=%s ",
 504                                 mech->gm_upcall_enctypes);
 505                 buflen -= len;
 506                 p += len;
 507                 gss_msg->msg.len += len;
 508         }
 509         len = scnprintf(p, buflen, "\n");
 510         if (len == 0)
 511                 goto out_overflow;
 512         gss_msg->msg.len += len;
 513
 514         gss_msg->msg.data = gss_msg->databuf;
 515         return 0;
 516 out_overflow:
 517         WARN_ON_ONCE(1);
 518         return -ENOMEM;
 519 }
 520
 521 static struct gss_upcall_msg *
 522 gss_alloc_msg(struct gss_auth *gss_auth,
 523                 kuid_t uid, const char *service_name)
 524 {
 525         struct gss_upcall_msg *gss_msg;
 526         int vers;
 527         int err = -ENOMEM;
 528
 529         gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
 530         if (gss_msg == NULL)
 531                 goto err;
 532         vers = get_pipe_version(gss_auth->net);
 533         err = vers;
 534         if (err < 0)
 535                 goto err_free_msg;
 536         gss_msg->pipe = gss_auth->gss_pipe[vers]->pipe;
 537         INIT_LIST_HEAD(&gss_msg->list);
 538         rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
 539         init_waitqueue_head(&gss_msg->waitqueue);
 540         refcount_set(&gss_msg->count, 1);
 541         gss_msg->uid = uid;
 542         gss_msg->auth = gss_auth;
 543         switch (vers) {
 544         case 0:
 545                 gss_encode_v0_msg(gss_msg);
 546                 break;
 547         default:
 548                 err = gss_encode_v1_msg(gss_msg, service_name, gss_auth->target_name);
 549                 if (err)
 550                         goto err_put_pipe_version;
 551         }
 552         kref_get(&gss_auth->kref);
 553         return gss_msg;
 554 err_put_pipe_version:
 555         put_pipe_version(gss_auth->net);
 556 err_free_msg:
 557         kfree(gss_msg);
 558 err:
 559         return ERR_PTR(err);
 560 }
 561
 562 static struct gss_upcall_msg *
 563 gss_setup_upcall(struct gss_auth *gss_auth, struct rpc_cred *cred)
 564 {
 565         struct gss_cred *gss_cred = container_of(cred,
 566                         struct gss_cred, gc_base);
 567         struct gss_upcall_msg *gss_new, *gss_msg;
 568         kuid_t uid = cred->cr_uid;
 569
 570         gss_new = gss_alloc_msg(gss_auth, uid, gss_cred->gc_principal);
 571         if (IS_ERR(gss_new))
 572                 return gss_new;
 573         gss_msg = gss_add_msg(gss_new);
 574         if (gss_msg == gss_new) {
 575                 int res;
 576                 refcount_inc(&gss_msg->count);
 577                 res = rpc_queue_upcall(gss_new->pipe, &gss_new->msg);
 578                 if (res) {
 579                         gss_unhash_msg(gss_new);
 580                         refcount_dec(&gss_msg->count);
 581                         gss_release_msg(gss_new);
 582                         gss_msg = ERR_PTR(res);
 583                 }
 584         } else
 585                 gss_release_msg(gss_new);
 586         return gss_msg;
 587 }
 588
 589 static void warn_gssd(void)
 590 {
 591         dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
 592 }
 593
 594 static inline int
 595 gss_refresh_upcall(struct rpc_task *task)
 596 {
 597         struct rpc_cred *cred = task->tk_rqstp->rq_cred;
 598         struct gss_auth *gss_auth = container_of(cred->cr_auth,
 599                         struct gss_auth, rpc_auth);
 600         struct gss_cred *gss_cred = container_of(cred,
 601                         struct gss_cred, gc_base);
 602         struct gss_upcall_msg *gss_msg;
 603         struct rpc_pipe *pipe;
 604         int err = 0;
 605
 606         dprintk("RPC: %5u %s for uid %u\n",
 607                 task->tk_pid, __func__, from_kuid(&init_user_ns, cred->cr_uid));
 608         gss_msg = gss_setup_upcall(gss_auth, cred);
 609         if (PTR_ERR(gss_msg) == -EAGAIN) {
 610                 /* XXX: warning on the first, under the assumption we
 611                  * shouldn't normally hit this case on a refresh. */
 612                 warn_gssd();
 613                 task->tk_timeout = 15*HZ;
 614                 rpc_sleep_on(&pipe_version_rpc_waitqueue, task, NULL);
 615                 return -EAGAIN;
 616         }
 617         if (IS_ERR(gss_msg)) {
 618                 err = PTR_ERR(gss_msg);
 619                 goto out;
 620         }
 621         pipe = gss_msg->pipe;
 622         spin_lock(&pipe->lock);
 623         if (gss_cred->gc_upcall != NULL)
 624                 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
 625         else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
 626                 task->tk_timeout = 0;
 627                 gss_cred->gc_upcall = gss_msg;
 628                 /* gss_upcall_callback will release the reference to gss_upcall_msg */
 629                 refcount_inc(&gss_msg->count);
 630                 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
 631         } else {
 632                 gss_handle_downcall_result(gss_cred, gss_msg);
 633                 err = gss_msg->msg.errno;
 634         }
 635         spin_unlock(&pipe->lock);
 636         gss_release_msg(gss_msg);
 637 out:
 638         dprintk("RPC: %5u %s for uid %u result %d\n",
 639                 task->tk_pid, __func__,
 640                 from_kuid(&init_user_ns, cred->cr_uid), err);
 641         return err;
 642 }
 643
 644 static inline int
 645 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
 646 {
 647         struct net *net = gss_auth->net;
 648         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 649         struct rpc_pipe *pipe;
 650         struct rpc_cred *cred = &gss_cred->gc_base;
 651         struct gss_upcall_msg *gss_msg;
 652         DEFINE_WAIT(wait);
 653         int err;
 654
 655         dprintk("RPC:       %s for uid %u\n",
 656                 __func__, from_kuid(&init_user_ns, cred->cr_uid));
 657 retry:
 658         err = 0;
 659         /* if gssd is down, just skip upcalling altogether */
 660         if (!gssd_running(net)) {
 661                 warn_gssd();
 662                 return -EACCES;
 663         }
 664         gss_msg = gss_setup_upcall(gss_auth, cred);
 665         if (PTR_ERR(gss_msg) == -EAGAIN) {
 666                 err = wait_event_interruptible_timeout(pipe_version_waitqueue,
 667                                 sn->pipe_version >= 0, 15 * HZ);
 668                 if (sn->pipe_version < 0) {
 669                         warn_gssd();
 670                         err = -EACCES;
 671                 }
 672                 if (err < 0)
 673                         goto out;
 674                 goto retry;
 675         }
 676         if (IS_ERR(gss_msg)) {
 677                 err = PTR_ERR(gss_msg);
 678                 goto out;
 679         }
 680         pipe = gss_msg->pipe;
 681         for (;;) {
 682                 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_KILLABLE);
 683                 spin_lock(&pipe->lock);
 684                 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
 685                         break;
 686                 }
 687                 spin_unlock(&pipe->lock);
 688                 if (fatal_signal_pending(current)) {
 689                         err = -ERESTARTSYS;
 690                         goto out_intr;
 691                 }
 692                 schedule();
 693         }
 694         if (gss_msg->ctx)
 695                 gss_cred_set_ctx(cred, gss_msg->ctx);
 696         else
 697                 err = gss_msg->msg.errno;
 698         spin_unlock(&pipe->lock);
 699 out_intr:
 700         finish_wait(&gss_msg->waitqueue, &wait);
 701         gss_release_msg(gss_msg);
 702 out:
 703         dprintk("RPC:       %s for uid %u result %d\n",
 704                 __func__, from_kuid(&init_user_ns, cred->cr_uid), err);
 705         return err;
 706 }
 707
 708 #define MSG_BUF_MAXSIZE 1024
 709
 710 static ssize_t
 711 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
 712 {
 713         const void *p, *end;
 714         void *buf;
 715         struct gss_upcall_msg *gss_msg;
 716         struct rpc_pipe *pipe = RPC_I(file_inode(filp))->pipe;
 717         struct gss_cl_ctx *ctx;
 718         uid_t id;
 719         kuid_t uid;
 720         ssize_t err = -EFBIG;
 721
 722         if (mlen > MSG_BUF_MAXSIZE)
 723                 goto out;
 724         err = -ENOMEM;
 725         buf = kmalloc(mlen, GFP_NOFS);
 726         if (!buf)
 727                 goto out;
 728
 729         err = -EFAULT;
 730         if (copy_from_user(buf, src, mlen))
 731                 goto err;
 732
 733         end = (const void *)((char *)buf + mlen);
 734         p = simple_get_bytes(buf, end, &id, sizeof(id));
 735         if (IS_ERR(p)) {
 736                 err = PTR_ERR(p);
 737                 goto err;
 738         }
 739
 740         uid = make_kuid(&init_user_ns, id);
 741         if (!uid_valid(uid)) {
 742                 err = -EINVAL;
 743                 goto err;
 744         }
 745
 746         err = -ENOMEM;
 747         ctx = gss_alloc_context();
 748         if (ctx == NULL)
 749                 goto err;
 750
 751         err = -ENOENT;
 752         /* Find a matching upcall */
 753         spin_lock(&pipe->lock);
 754         gss_msg = __gss_find_upcall(pipe, uid, NULL);
 755         if (gss_msg == NULL) {
 756                 spin_unlock(&pipe->lock);
 757                 goto err_put_ctx;
 758         }
 759         list_del_init(&gss_msg->list);
 760         spin_unlock(&pipe->lock);
 761
 762         p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
 763         if (IS_ERR(p)) {
 764                 err = PTR_ERR(p);
 765                 switch (err) {
 766                 case -EACCES:
 767                 case -EKEYEXPIRED:
 768                         gss_msg->msg.errno = err;
 769                         err = mlen;
 770                         break;
 771                 case -EFAULT:
 772                 case -ENOMEM:
 773                 case -EINVAL:
 774                 case -ENOSYS:
 775                         gss_msg->msg.errno = -EAGAIN;
 776                         break;
 777                 default:
 778                         printk(KERN_CRIT "%s: bad return from "
 779                                 "gss_fill_context: %zd\n", __func__, err);
 780                         gss_msg->msg.errno = -EIO;
 781                 }
 782                 goto err_release_msg;
 783         }
 784         gss_msg->ctx = gss_get_ctx(ctx);
 785         err = mlen;
 786
 787 err_release_msg:
 788         spin_lock(&pipe->lock);
 789         __gss_unhash_msg(gss_msg);
 790         spin_unlock(&pipe->lock);
 791         gss_release_msg(gss_msg);
 792 err_put_ctx:
 793         gss_put_ctx(ctx);
 794 err:
 795         kfree(buf);
 796 out:
 797         dprintk("RPC:       %s returning %zd\n", __func__, err);
 798         return err;
 799 }
 800
 801 static int gss_pipe_open(struct inode *inode, int new_version)
 802 {
 803         struct net *net = inode->i_sb->s_fs_info;
 804         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 805         int ret = 0;
 806
 807         spin_lock(&pipe_version_lock);
 808         if (sn->pipe_version < 0) {
 809                 /* First open of any gss pipe determines the version: */
 810                 sn->pipe_version = new_version;
 811                 rpc_wake_up(&pipe_version_rpc_waitqueue);
 812                 wake_up(&pipe_version_waitqueue);
 813         } else if (sn->pipe_version != new_version) {
 814                 /* Trying to open a pipe of a different version */
 815                 ret = -EBUSY;
 816                 goto out;
 817         }
 818         atomic_inc(&sn->pipe_users);
 819 out:
 820         spin_unlock(&pipe_version_lock);
 821         return ret;
 822
 823 }
 824
 825 static int gss_pipe_open_v0(struct inode *inode)
 826 {
 827         return gss_pipe_open(inode, 0);
 828 }
 829
 830 static int gss_pipe_open_v1(struct inode *inode)
 831 {
 832         return gss_pipe_open(inode, 1);
 833 }
 834
 835 static void
 836 gss_pipe_release(struct inode *inode)
 837 {
 838         struct net *net = inode->i_sb->s_fs_info;
 839         struct rpc_pipe *pipe = RPC_I(inode)->pipe;
 840         struct gss_upcall_msg *gss_msg;
 841
 842 restart:
 843         spin_lock(&pipe->lock);
 844         list_for_each_entry(gss_msg, &pipe->in_downcall, list) {
 845
 846                 if (!list_empty(&gss_msg->msg.list))
 847                         continue;
 848                 gss_msg->msg.errno = -EPIPE;
 849                 refcount_inc(&gss_msg->count);
 850                 __gss_unhash_msg(gss_msg);
 851                 spin_unlock(&pipe->lock);
 852                 gss_release_msg(gss_msg);
 853                 goto restart;
 854         }
 855         spin_unlock(&pipe->lock);
 856
 857         put_pipe_version(net);
 858 }
 859
 860 static void
 861 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
 862 {
 863         struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
 864
 865         if (msg->errno < 0) {
 866                 dprintk("RPC:       %s releasing msg %p\n",
 867                         __func__, gss_msg);
 868                 refcount_inc(&gss_msg->count);
 869                 gss_unhash_msg(gss_msg);
 870                 if (msg->errno == -ETIMEDOUT)
 871                         warn_gssd();
 872                 gss_release_msg(gss_msg);
 873         }
 874         gss_release_msg(gss_msg);
 875 }
 876
 877 static void gss_pipe_dentry_destroy(struct dentry *dir,
 878                 struct rpc_pipe_dir_object *pdo)
 879 {
 880         struct gss_pipe *gss_pipe = pdo->pdo_data;
 881         struct rpc_pipe *pipe = gss_pipe->pipe;
 882
 883         if (pipe->dentry != NULL) {
 884                 rpc_unlink(pipe->dentry);
 885                 pipe->dentry = NULL;
 886         }
 887 }
 888
 889 static int gss_pipe_dentry_create(struct dentry *dir,
 890                 struct rpc_pipe_dir_object *pdo)
 891 {
 892         struct gss_pipe *p = pdo->pdo_data;
 893         struct dentry *dentry;
 894
 895         dentry = rpc_mkpipe_dentry(dir, p->name, p->clnt, p->pipe);
 896         if (IS_ERR(dentry))
 897                 return PTR_ERR(dentry);
 898         p->pipe->dentry = dentry;
 899         return 0;
 900 }
 901
 902 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops = {
 903         .create = gss_pipe_dentry_create,
 904         .destroy = gss_pipe_dentry_destroy,
 905 };
 906
 907 static struct gss_pipe *gss_pipe_alloc(struct rpc_clnt *clnt,
 908                 const char *name,
 909                 const struct rpc_pipe_ops *upcall_ops)
 910 {
 911         struct gss_pipe *p;
 912         int err = -ENOMEM;
 913
 914         p = kmalloc(sizeof(*p), GFP_KERNEL);
 915         if (p == NULL)
 916                 goto err;
 917         p->pipe = rpc_mkpipe_data(upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
 918         if (IS_ERR(p->pipe)) {
 919                 err = PTR_ERR(p->pipe);
 920                 goto err_free_gss_pipe;
 921         }
 922         p->name = name;
 923         p->clnt = clnt;
 924         kref_init(&p->kref);
 925         rpc_init_pipe_dir_object(&p->pdo,
 926                         &gss_pipe_dir_object_ops,
 927                         p);
 928         return p;
 929 err_free_gss_pipe:
 930         kfree(p);
 931 err:
 932         return ERR_PTR(err);
 933 }
 934
 935 struct gss_alloc_pdo {
 936         struct rpc_clnt *clnt;
 937         const char *name;
 938         const struct rpc_pipe_ops *upcall_ops;
 939 };
 940
 941 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object *pdo, void *data)
 942 {
 943         struct gss_pipe *gss_pipe;
 944         struct gss_alloc_pdo *args = data;
 945
 946         if (pdo->pdo_ops != &gss_pipe_dir_object_ops)
 947                 return 0;
 948         gss_pipe = container_of(pdo, struct gss_pipe, pdo);
 949         if (strcmp(gss_pipe->name, args->name) != 0)
 950                 return 0;
 951         if (!kref_get_unless_zero(&gss_pipe->kref))
 952                 return 0;
 953         return 1;
 954 }
 955
 956 static struct rpc_pipe_dir_object *gss_pipe_alloc_pdo(void *data)
 957 {
 958         struct gss_pipe *gss_pipe;
 959         struct gss_alloc_pdo *args = data;
 960
 961         gss_pipe = gss_pipe_alloc(args->clnt, args->name, args->upcall_ops);
 962         if (!IS_ERR(gss_pipe))
 963                 return &gss_pipe->pdo;
 964         return NULL;
 965 }
 966
 967 static struct gss_pipe *gss_pipe_get(struct rpc_clnt *clnt,
 968                 const char *name,
 969                 const struct rpc_pipe_ops *upcall_ops)
 970 {
 971         struct net *net = rpc_net_ns(clnt);
 972         struct rpc_pipe_dir_object *pdo;
 973         struct gss_alloc_pdo args = {
 974                 .clnt = clnt,
 975                 .name = name,
 976                 .upcall_ops = upcall_ops,
 977         };
 978
 979         pdo = rpc_find_or_alloc_pipe_dir_object(net,
 980                         &clnt->cl_pipedir_objects,
 981                         gss_pipe_match_pdo,
 982                         gss_pipe_alloc_pdo,
 983                         &args);
 984         if (pdo != NULL)
 985                 return container_of(pdo, struct gss_pipe, pdo);
 986         return ERR_PTR(-ENOMEM);
 987 }
 988
 989 static void __gss_pipe_free(struct gss_pipe *p)
 990 {
 991         struct rpc_clnt *clnt = p->clnt;
 992         struct net *net = rpc_net_ns(clnt);
 993
 994         rpc_remove_pipe_dir_object(net,
 995                         &clnt->cl_pipedir_objects,
 996                         &p->pdo);
 997         rpc_destroy_pipe_data(p->pipe);
 998         kfree(p);
 999 }
1000
1001 static void __gss_pipe_release(struct kref *kref)
1002 {
1003         struct gss_pipe *p = container_of(kref, struct gss_pipe, kref);
1004
1005         __gss_pipe_free(p);
1006 }
1007
1008 static void gss_pipe_free(struct gss_pipe *p)
1009 {
1010         if (p != NULL)
1011                 kref_put(&p->kref, __gss_pipe_release);
1012 }
1013
1014 /*
1015  * NOTE: we have the opportunity to use different
1016  * parameters based on the input flavor (which must be a pseudoflavor)
1017  */
1018 static struct gss_auth *
1019 gss_create_new(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1020 {
1021         rpc_authflavor_t flavor = args->pseudoflavor;
1022         struct gss_auth *gss_auth;
1023         struct gss_pipe *gss_pipe;
1024         struct rpc_auth * auth;
1025         int err = -ENOMEM; /* XXX? */
1026
1027         dprintk("RPC:       creating GSS authenticator for client %p\n", clnt);
1028
1029         if (!try_module_get(THIS_MODULE))
1030                 return ERR_PTR(err);
1031         if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
1032                 goto out_dec;
1033         INIT_HLIST_NODE(&gss_auth->hash);
1034         gss_auth->target_name = NULL;
1035         if (args->target_name) {
1036                 gss_auth->target_name = kstrdup(args->target_name, GFP_KERNEL);
1037                 if (gss_auth->target_name == NULL)
1038                         goto err_free;
1039         }
1040         gss_auth->client = clnt;
1041         gss_auth->net = get_net(rpc_net_ns(clnt));
1042         err = -EINVAL;
1043         gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
1044         if (!gss_auth->mech) {
1045                 dprintk("RPC:       Pseudoflavor %d not found!\n", flavor);
1046                 goto err_put_net;
1047         }
1048         gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
1049         if (gss_auth->service == 0)
1050                 goto err_put_mech;
1051         if (!gssd_running(gss_auth->net))
1052                 goto err_put_mech;
1053         auth = &gss_auth->rpc_auth;
1054         auth->au_cslack = GSS_CRED_SLACK >> 2;
1055         auth->au_rslack = GSS_VERF_SLACK >> 2;
1056         auth->au_flags = 0;
1057         auth->au_ops = &authgss_ops;
1058         auth->au_flavor = flavor;
1059         if (gss_pseudoflavor_to_datatouch(gss_auth->mech, flavor))
1060                 auth->au_flags |= RPCAUTH_AUTH_DATATOUCH;
1061         refcount_set(&auth->au_count, 1);
1062         kref_init(&gss_auth->kref);
1063
1064         err = rpcauth_init_credcache(auth);
1065         if (err)
1066                 goto err_put_mech;
1067         /*
1068          * Note: if we created the old pipe first, then someone who
1069          * examined the directory at the right moment might conclude
1070          * that we supported only the old pipe.  So we instead create
1071          * the new pipe first.
1072          */
1073         gss_pipe = gss_pipe_get(clnt, "gssd", &gss_upcall_ops_v1);
1074         if (IS_ERR(gss_pipe)) {
1075                 err = PTR_ERR(gss_pipe);
1076                 goto err_destroy_credcache;
1077         }
1078         gss_auth->gss_pipe[1] = gss_pipe;
1079
1080         gss_pipe = gss_pipe_get(clnt, gss_auth->mech->gm_name,
1081                         &gss_upcall_ops_v0);
1082         if (IS_ERR(gss_pipe)) {
1083                 err = PTR_ERR(gss_pipe);
1084                 goto err_destroy_pipe_1;
1085         }
1086         gss_auth->gss_pipe[0] = gss_pipe;
1087
1088         return gss_auth;
1089 err_destroy_pipe_1:
1090         gss_pipe_free(gss_auth->gss_pipe[1]);
1091 err_destroy_credcache:
1092         rpcauth_destroy_credcache(auth);
1093 err_put_mech:
1094         gss_mech_put(gss_auth->mech);
1095 err_put_net:
1096         put_net(gss_auth->net);
1097 err_free:
1098         kfree(gss_auth->target_name);
1099         kfree(gss_auth);
1100 out_dec:
1101         module_put(THIS_MODULE);
1102         return ERR_PTR(err);
1103 }
1104
1105 static void
1106 gss_free(struct gss_auth *gss_auth)
1107 {
1108         gss_pipe_free(gss_auth->gss_pipe[0]);
1109         gss_pipe_free(gss_auth->gss_pipe[1]);
1110         gss_mech_put(gss_auth->mech);
1111         put_net(gss_auth->net);
1112         kfree(gss_auth->target_name);
1113
1114         kfree(gss_auth);
1115         module_put(THIS_MODULE);
1116 }
1117
1118 static void
1119 gss_free_callback(struct kref *kref)
1120 {
1121         struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
1122
1123         gss_free(gss_auth);
1124 }
1125
1126 static void
1127 gss_put_auth(struct gss_auth *gss_auth)
1128 {
1129         kref_put(&gss_auth->kref, gss_free_callback);
1130 }
1131
1132 static void
1133 gss_destroy(struct rpc_auth *auth)
1134 {
1135         struct gss_auth *gss_auth = container_of(auth,
1136                         struct gss_auth, rpc_auth);
1137
1138         dprintk("RPC:       destroying GSS authenticator %p flavor %d\n",
1139                         auth, auth->au_flavor);
1140
1141         if (hash_hashed(&gss_auth->hash)) {
1142                 spin_lock(&gss_auth_hash_lock);
1143                 hash_del(&gss_auth->hash);
1144                 spin_unlock(&gss_auth_hash_lock);
1145         }
1146
1147         gss_pipe_free(gss_auth->gss_pipe[0]);
1148         gss_auth->gss_pipe[0] = NULL;
1149         gss_pipe_free(gss_auth->gss_pipe[1]);
1150         gss_auth->gss_pipe[1] = NULL;
1151         rpcauth_destroy_credcache(auth);
1152
1153         gss_put_auth(gss_auth);
1154 }
1155
1156 /*
1157  * Auths may be shared between rpc clients that were cloned from a
1158  * common client with the same xprt, if they also share the flavor and
1159  * target_name.
1160  *
1161  * The auth is looked up from the oldest parent sharing the same
1162  * cl_xprt, and the auth itself references only that common parent
1163  * (which is guaranteed to last as long as any of its descendants).
1164  */
1165 static struct gss_auth *
1166 gss_auth_find_or_add_hashed(const struct rpc_auth_create_args *args,
1167                 struct rpc_clnt *clnt,
1168                 struct gss_auth *new)
1169 {
1170         struct gss_auth *gss_auth;
1171         unsigned long hashval = (unsigned long)clnt;
1172
1173         spin_lock(&gss_auth_hash_lock);
1174         hash_for_each_possible(gss_auth_hash_table,
1175                         gss_auth,
1176                         hash,
1177                         hashval) {
1178                 if (gss_auth->client != clnt)
1179                         continue;
1180                 if (gss_auth->rpc_auth.au_flavor != args->pseudoflavor)
1181                         continue;
1182                 if (gss_auth->target_name != args->target_name) {
1183                         if (gss_auth->target_name == NULL)
1184                                 continue;
1185                         if (args->target_name == NULL)
1186                                 continue;
1187                         if (strcmp(gss_auth->target_name, args->target_name))
1188                                 continue;
1189                 }
1190                 if (!refcount_inc_not_zero(&gss_auth->rpc_auth.au_count))
1191                         continue;
1192                 goto out;
1193         }
1194         if (new)
1195                 hash_add(gss_auth_hash_table, &new->hash, hashval);
1196         gss_auth = new;
1197 out:
1198         spin_unlock(&gss_auth_hash_lock);
1199         return gss_auth;
1200 }
1201
1202 static struct gss_auth *
1203 gss_create_hashed(const struct rpc_auth_create_args *args,
1204                   struct rpc_clnt *clnt)
1205 {
1206         struct gss_auth *gss_auth;
1207         struct gss_auth *new;
1208
1209         gss_auth = gss_auth_find_or_add_hashed(args, clnt, NULL);
1210         if (gss_auth != NULL)
1211                 goto out;
1212         new = gss_create_new(args, clnt);
1213         if (IS_ERR(new))
1214                 return new;
1215         gss_auth = gss_auth_find_or_add_hashed(args, clnt, new);
1216         if (gss_auth != new)
1217                 gss_destroy(&new->rpc_auth);
1218 out:
1219         return gss_auth;
1220 }
1221
1222 static struct rpc_auth *
1223 gss_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1224 {
1225         struct gss_auth *gss_auth;
1226         struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
1227
1228         while (clnt != clnt->cl_parent) {
1229                 struct rpc_clnt *parent = clnt->cl_parent;
1230                 /* Find the original parent for this transport */
1231                 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
1232                         break;
1233                 clnt = parent;
1234         }
1235
1236         gss_auth = gss_create_hashed(args, clnt);
1237         if (IS_ERR(gss_auth))
1238                 return ERR_CAST(gss_auth);
1239         return &gss_auth->rpc_auth;
1240 }
1241
1242 static struct gss_cred *
1243 gss_dup_cred(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
1244 {
1245         struct gss_cred *new;
1246
1247         /* Make a copy of the cred so that we can reference count it */
1248         new = kzalloc(sizeof(*gss_cred), GFP_NOIO);
1249         if (new) {
1250                 struct auth_cred acred = {
1251                         .uid = gss_cred->gc_base.cr_uid,
1252                 };
1253                 struct gss_cl_ctx *ctx =
1254                         rcu_dereference_protected(gss_cred->gc_ctx, 1);
1255
1256                 rpcauth_init_cred(&new->gc_base, &acred,
1257                                 &gss_auth->rpc_auth,
1258                                 &gss_nullops);
1259                 new->gc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
1260                 new->gc_service = gss_cred->gc_service;
1261                 new->gc_principal = gss_cred->gc_principal;
1262                 kref_get(&gss_auth->kref);
1263                 rcu_assign_pointer(new->gc_ctx, ctx);
1264                 gss_get_ctx(ctx);
1265         }
1266         return new;
1267 }
1268
1269 /*
1270  * gss_send_destroy_context will cause the RPCSEC_GSS to send a NULL RPC call
1271  * to the server with the GSS control procedure field set to
1272  * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1273  * all RPCSEC_GSS state associated with that context.
1274  */
1275 static void
1276 gss_send_destroy_context(struct rpc_cred *cred)
1277 {
1278         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1279         struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1280         struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1281         struct gss_cred *new;
1282         struct rpc_task *task;
1283
1284         new = gss_dup_cred(gss_auth, gss_cred);
1285         if (new) {
1286                 ctx->gc_proc = RPC_GSS_PROC_DESTROY;
1287
1288                 task = rpc_call_null(gss_auth->client, &new->gc_base,
1289                                 RPC_TASK_ASYNC|RPC_TASK_SOFT);
1290                 if (!IS_ERR(task))
1291                         rpc_put_task(task);
1292
1293                 put_rpccred(&new->gc_base);
1294         }
1295 }
1296
1297 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1298  * to create a new cred or context, so they check that things have been
1299  * allocated before freeing them. */
1300 static void
1301 gss_do_free_ctx(struct gss_cl_ctx *ctx)
1302 {
1303         dprintk("RPC:       %s\n", __func__);
1304
1305         gss_delete_sec_context(&ctx->gc_gss_ctx);
1306         kfree(ctx->gc_wire_ctx.data);
1307         kfree(ctx->gc_acceptor.data);
1308         kfree(ctx);
1309 }
1310
1311 static void
1312 gss_free_ctx_callback(struct rcu_head *head)
1313 {
1314         struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
1315         gss_do_free_ctx(ctx);
1316 }
1317
1318 static void
1319 gss_free_ctx(struct gss_cl_ctx *ctx)
1320 {
1321         call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
1322 }
1323
1324 static void
1325 gss_free_cred(struct gss_cred *gss_cred)
1326 {
1327         dprintk("RPC:       %s cred=%p\n", __func__, gss_cred);
1328         kfree(gss_cred);
1329 }
1330
1331 static void
1332 gss_free_cred_callback(struct rcu_head *head)
1333 {
1334         struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
1335         gss_free_cred(gss_cred);
1336 }
1337
1338 static void
1339 gss_destroy_nullcred(struct rpc_cred *cred)
1340 {
1341         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1342         struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1343         struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1344
1345         RCU_INIT_POINTER(gss_cred->gc_ctx, NULL);
1346         call_rcu(&cred->cr_rcu, gss_free_cred_callback);
1347         if (ctx)
1348                 gss_put_ctx(ctx);
1349         gss_put_auth(gss_auth);
1350 }
1351
1352 static void
1353 gss_destroy_cred(struct rpc_cred *cred)
1354 {
1355
1356         if (test_and_clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0)
1357                 gss_send_destroy_context(cred);
1358         gss_destroy_nullcred(cred);
1359 }
1360
1361 static int
1362 gss_hash_cred(struct auth_cred *acred, unsigned int hashbits)
1363 {
1364         return hash_64(from_kuid(&init_user_ns, acred->uid), hashbits);
1365 }
1366
1367 /*
1368  * Lookup RPCSEC_GSS cred for the current process
1369  */
1370 static struct rpc_cred *
1371 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1372 {
1373         return rpcauth_lookup_credcache(auth, acred, flags, GFP_NOFS);
1374 }
1375
1376 static struct rpc_cred *
1377 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp)
1378 {
1379         struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1380         struct gss_cred *cred = NULL;
1381         int err = -ENOMEM;
1382
1383         dprintk("RPC:       %s for uid %d, flavor %d\n",
1384                 __func__, from_kuid(&init_user_ns, acred->uid),
1385                 auth->au_flavor);
1386
1387         if (!(cred = kzalloc(sizeof(*cred), gfp)))
1388                 goto out_err;
1389
1390         rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
1391         /*
1392          * Note: in order to force a call to call_refresh(), we deliberately
1393          * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1394          */
1395         cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
1396         cred->gc_service = gss_auth->service;
1397         cred->gc_principal = NULL;
1398         if (acred->machine_cred)
1399                 cred->gc_principal = acred->principal;
1400         kref_get(&gss_auth->kref);
1401         return &cred->gc_base;
1402
1403 out_err:
1404         dprintk("RPC:       %s failed with error %d\n", __func__, err);
1405         return ERR_PTR(err);
1406 }
1407
1408 static int
1409 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
1410 {
1411         struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1412         struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
1413         int err;
1414
1415         do {
1416                 err = gss_create_upcall(gss_auth, gss_cred);
1417         } while (err == -EAGAIN);
1418         return err;
1419 }
1420
1421 static char *
1422 gss_stringify_acceptor(struct rpc_cred *cred)
1423 {
1424         char *string = NULL;
1425         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1426         struct gss_cl_ctx *ctx;
1427         unsigned int len;
1428         struct xdr_netobj *acceptor;
1429
1430         rcu_read_lock();
1431         ctx = rcu_dereference(gss_cred->gc_ctx);
1432         if (!ctx)
1433                 goto out;
1434
1435         len = ctx->gc_acceptor.len;
1436         rcu_read_unlock();
1437
1438         /* no point if there's no string */
1439         if (!len)
1440                 return NULL;
1441 realloc:
1442         string = kmalloc(len + 1, GFP_KERNEL);
1443         if (!string)
1444                 return NULL;
1445
1446         rcu_read_lock();
1447         ctx = rcu_dereference(gss_cred->gc_ctx);
1448
1449         /* did the ctx disappear or was it replaced by one with no acceptor? */
1450         if (!ctx || !ctx->gc_acceptor.len) {
1451                 kfree(string);
1452                 string = NULL;
1453                 goto out;
1454         }
1455
1456         acceptor = &ctx->gc_acceptor;
1457
1458         /*
1459          * Did we find a new acceptor that's longer than the original? Allocate
1460          * a longer buffer and try again.
1461          */
1462         if (len < acceptor->len) {
1463                 len = acceptor->len;
1464                 rcu_read_unlock();
1465                 kfree(string);
1466                 goto realloc;
1467         }
1468
1469         memcpy(string, acceptor->data, acceptor->len);
1470         string[acceptor->len] = '\0';
1471 out:
1472         rcu_read_unlock();
1473         return string;
1474 }
1475
1476 /*
1477  * Returns -EACCES if GSS context is NULL or will expire within the
1478  * timeout (miliseconds)
1479  */
1480 static int
1481 gss_key_timeout(struct rpc_cred *rc)
1482 {
1483         struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1484         struct gss_cl_ctx *ctx;
1485         unsigned long timeout = jiffies + (gss_key_expire_timeo * HZ);
1486         int ret = 0;
1487
1488         rcu_read_lock();
1489         ctx = rcu_dereference(gss_cred->gc_ctx);
1490         if (!ctx || time_after(timeout, ctx->gc_expiry))
1491                 ret = -EACCES;
1492         rcu_read_unlock();
1493
1494         return ret;
1495 }
1496
1497 static int
1498 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
1499 {
1500         struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1501         struct gss_cl_ctx *ctx;
1502         int ret;
1503
1504         if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
1505                 goto out;
1506         /* Don't match with creds that have expired. */
1507         rcu_read_lock();
1508         ctx = rcu_dereference(gss_cred->gc_ctx);
1509         if (!ctx || time_after(jiffies, ctx->gc_expiry)) {
1510                 rcu_read_unlock();
1511                 return 0;
1512         }
1513         rcu_read_unlock();
1514         if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
1515                 return 0;
1516 out:
1517         if (acred->principal != NULL) {
1518                 if (gss_cred->gc_principal == NULL)
1519                         return 0;
1520                 ret = strcmp(acred->principal, gss_cred->gc_principal) == 0;
1521                 goto check_expire;
1522         }
1523         if (gss_cred->gc_principal != NULL)
1524                 return 0;
1525         ret = uid_eq(rc->cr_uid, acred->uid);
1526
1527 check_expire:
1528         if (ret == 0)
1529                 return ret;
1530
1531         /* Notify acred users of GSS context expiration timeout */
1532         if (test_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags) &&
1533             (gss_key_timeout(rc) != 0)) {
1534                 /* test will now be done from generic cred */
1535                 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags);
1536                 /* tell NFS layer that key will expire soon */
1537                 set_bit(RPC_CRED_KEY_EXPIRE_SOON, &acred->ac_flags);
1538         }
1539         return ret;
1540 }
1541
1542 /*
1543 * Marshal credentials.
1544 * Maybe we should keep a cached credential for performance reasons.
1545 */
1546 static __be32 *
1547 gss_marshal(struct rpc_task *task, __be32 *p)
1548 {
1549         struct rpc_rqst *req = task->tk_rqstp;
1550         struct rpc_cred *cred = req->rq_cred;
1551         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1552                                                  gc_base);
1553         struct gss_cl_ctx       *ctx = gss_cred_get_ctx(cred);
1554         __be32          *cred_len;
1555         u32             maj_stat = 0;
1556         struct xdr_netobj mic;
1557         struct kvec     iov;
1558         struct xdr_buf  verf_buf;
1559
1560         dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1561
1562         *p++ = htonl(RPC_AUTH_GSS);
1563         cred_len = p++;
1564
1565         spin_lock(&ctx->gc_seq_lock);
1566         req->rq_seqno = ctx->gc_seq++;
1567         spin_unlock(&ctx->gc_seq_lock);
1568
1569         *p++ = htonl((u32) RPC_GSS_VERSION);
1570         *p++ = htonl((u32) ctx->gc_proc);
1571         *p++ = htonl((u32) req->rq_seqno);
1572         *p++ = htonl((u32) gss_cred->gc_service);
1573         p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
1574         *cred_len = htonl((p - (cred_len + 1)) << 2);
1575
1576         /* We compute the checksum for the verifier over the xdr-encoded bytes
1577          * starting with the xid and ending at the end of the credential: */
1578         iov.iov_base = xprt_skip_transport_header(req->rq_xprt,
1579                                         req->rq_snd_buf.head[0].iov_base);
1580         iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
1581         xdr_buf_from_iov(&iov, &verf_buf);
1582
1583         /* set verifier flavor*/
1584         *p++ = htonl(RPC_AUTH_GSS);
1585
1586         mic.data = (u8 *)(p + 1);
1587         maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1588         if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
1589                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1590         } else if (maj_stat != 0) {
1591                 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
1592                 goto out_put_ctx;
1593         }
1594         p = xdr_encode_opaque(p, NULL, mic.len);
1595         gss_put_ctx(ctx);
1596         return p;
1597 out_put_ctx:
1598         gss_put_ctx(ctx);
1599         return NULL;
1600 }
1601
1602 static int gss_renew_cred(struct rpc_task *task)
1603 {
1604         struct rpc_cred *oldcred = task->tk_rqstp->rq_cred;
1605         struct gss_cred *gss_cred = container_of(oldcred,
1606                                                  struct gss_cred,
1607                                                  gc_base);
1608         struct rpc_auth *auth = oldcred->cr_auth;
1609         struct auth_cred acred = {
1610                 .uid = oldcred->cr_uid,
1611                 .principal = gss_cred->gc_principal,
1612                 .machine_cred = (gss_cred->gc_principal != NULL ? 1 : 0),
1613         };
1614         struct rpc_cred *new;
1615
1616         new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
1617         if (IS_ERR(new))
1618                 return PTR_ERR(new);
1619         task->tk_rqstp->rq_cred = new;
1620         put_rpccred(oldcred);
1621         return 0;
1622 }
1623
1624 static int gss_cred_is_negative_entry(struct rpc_cred *cred)
1625 {
1626         if (test_bit(RPCAUTH_CRED_NEGATIVE, &cred->cr_flags)) {
1627                 unsigned long now = jiffies;
1628                 unsigned long begin, expire;
1629                 struct gss_cred *gss_cred;
1630
1631                 gss_cred = container_of(cred, struct gss_cred, gc_base);
1632                 begin = gss_cred->gc_upcall_timestamp;
1633                 expire = begin + gss_expired_cred_retry_delay * HZ;
1634
1635                 if (time_in_range_open(now, begin, expire))
1636                         return 1;
1637         }
1638         return 0;
1639 }
1640
1641 /*
1642 * Refresh credentials. XXX - finish
1643 */
1644 static int
1645 gss_refresh(struct rpc_task *task)
1646 {
1647         struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1648         int ret = 0;
1649
1650         if (gss_cred_is_negative_entry(cred))
1651                 return -EKEYEXPIRED;
1652
1653         if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
1654                         !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
1655                 ret = gss_renew_cred(task);
1656                 if (ret < 0)
1657                         goto out;
1658                 cred = task->tk_rqstp->rq_cred;
1659         }
1660
1661         if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
1662                 ret = gss_refresh_upcall(task);
1663 out:
1664         return ret;
1665 }
1666
1667 /* Dummy refresh routine: used only when destroying the context */
1668 static int
1669 gss_refresh_null(struct rpc_task *task)
1670 {
1671         return 0;
1672 }
1673
1674 static __be32 *
1675 gss_validate(struct rpc_task *task, __be32 *p)
1676 {
1677         struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1678         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1679         __be32          *seq = NULL;
1680         struct kvec     iov;
1681         struct xdr_buf  verf_buf;
1682         struct xdr_netobj mic;
1683         u32             flav,len;
1684         u32             maj_stat;
1685         __be32          *ret = ERR_PTR(-EIO);
1686
1687         dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1688
1689         flav = ntohl(*p++);
1690         if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
1691                 goto out_bad;
1692         if (flav != RPC_AUTH_GSS)
1693                 goto out_bad;
1694         seq = kmalloc(4, GFP_NOFS);
1695         if (!seq)
1696                 goto out_bad;
1697         *seq = htonl(task->tk_rqstp->rq_seqno);
1698         iov.iov_base = seq;
1699         iov.iov_len = 4;
1700         xdr_buf_from_iov(&iov, &verf_buf);
1701         mic.data = (u8 *)p;
1702         mic.len = len;
1703
1704         ret = ERR_PTR(-EACCES);
1705         maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1706         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1707                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1708         if (maj_stat) {
1709                 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1710                         task->tk_pid, __func__, maj_stat);
1711                 goto out_bad;
1712         }
1713         /* We leave it to unwrap to calculate au_rslack. For now we just
1714          * calculate the length of the verifier: */
1715         cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1716         gss_put_ctx(ctx);
1717         dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1718                         task->tk_pid, __func__);
1719         kfree(seq);
1720         return p + XDR_QUADLEN(len);
1721 out_bad:
1722         gss_put_ctx(ctx);
1723         dprintk("RPC: %5u %s failed ret %ld.\n", task->tk_pid, __func__,
1724                 PTR_ERR(ret));
1725         kfree(seq);
1726         return ret;
1727 }
1728
1729 static void gss_wrap_req_encode(kxdreproc_t encode, struct rpc_rqst *rqstp,
1730                                 __be32 *p, void *obj)
1731 {
1732         struct xdr_stream xdr;
1733
1734         xdr_init_encode(&xdr, &rqstp->rq_snd_buf, p);
1735         encode(rqstp, &xdr, obj);
1736 }
1737
1738 static inline int
1739 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1740                    kxdreproc_t encode, struct rpc_rqst *rqstp,
1741                    __be32 *p, void *obj)
1742 {
1743         struct xdr_buf  *snd_buf = &rqstp->rq_snd_buf;
1744         struct xdr_buf  integ_buf;
1745         __be32          *integ_len = NULL;
1746         struct xdr_netobj mic;
1747         u32             offset;
1748         __be32          *q;
1749         struct kvec     *iov;
1750         u32             maj_stat = 0;
1751         int             status = -EIO;
1752
1753         integ_len = p++;
1754         offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1755         *p++ = htonl(rqstp->rq_seqno);
1756
1757         gss_wrap_req_encode(encode, rqstp, p, obj);
1758
1759         if (xdr_buf_subsegment(snd_buf, &integ_buf,
1760                                 offset, snd_buf->len - offset))
1761                 return status;
1762         *integ_len = htonl(integ_buf.len);
1763
1764         /* guess whether we're in the head or the tail: */
1765         if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1766                 iov = snd_buf->tail;
1767         else
1768                 iov = snd_buf->head;
1769         p = iov->iov_base + iov->iov_len;
1770         mic.data = (u8 *)(p + 1);
1771
1772         maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1773         status = -EIO; /* XXX? */
1774         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1775                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1776         else if (maj_stat)
1777                 return status;
1778         q = xdr_encode_opaque(p, NULL, mic.len);
1779
1780         offset = (u8 *)q - (u8 *)p;
1781         iov->iov_len += offset;
1782         snd_buf->len += offset;
1783         return 0;
1784 }
1785
1786 static void
1787 priv_release_snd_buf(struct rpc_rqst *rqstp)
1788 {
1789         int i;
1790
1791         for (i=0; i < rqstp->rq_enc_pages_num; i++)
1792                 __free_page(rqstp->rq_enc_pages[i]);
1793         kfree(rqstp->rq_enc_pages);
1794 }
1795
1796 static int
1797 alloc_enc_pages(struct rpc_rqst *rqstp)
1798 {
1799         struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1800         int first, last, i;
1801
1802         if (snd_buf->page_len == 0) {
1803                 rqstp->rq_enc_pages_num = 0;
1804                 return 0;
1805         }
1806
1807         first = snd_buf->page_base >> PAGE_SHIFT;
1808         last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_SHIFT;
1809         rqstp->rq_enc_pages_num = last - first + 1 + 1;
1810         rqstp->rq_enc_pages
1811                 = kmalloc_array(rqstp->rq_enc_pages_num,
1812                                 sizeof(struct page *),
1813                                 GFP_NOFS);
1814         if (!rqstp->rq_enc_pages)
1815                 goto out;
1816         for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1817                 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1818                 if (rqstp->rq_enc_pages[i] == NULL)
1819                         goto out_free;
1820         }
1821         rqstp->rq_release_snd_buf = priv_release_snd_buf;
1822         return 0;
1823 out_free:
1824         rqstp->rq_enc_pages_num = i;
1825         priv_release_snd_buf(rqstp);
1826 out:
1827         return -EAGAIN;
1828 }
1829
1830 static inline int
1831 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1832                   kxdreproc_t encode, struct rpc_rqst *rqstp,
1833                   __be32 *p, void *obj)
1834 {
1835         struct xdr_buf  *snd_buf = &rqstp->rq_snd_buf;
1836         u32             offset;
1837         u32             maj_stat;
1838         int             status;
1839         __be32          *opaque_len;
1840         struct page     **inpages;
1841         int             first;
1842         int             pad;
1843         struct kvec     *iov;
1844         char            *tmp;
1845
1846         opaque_len = p++;
1847         offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1848         *p++ = htonl(rqstp->rq_seqno);
1849
1850         gss_wrap_req_encode(encode, rqstp, p, obj);
1851
1852         status = alloc_enc_pages(rqstp);
1853         if (status)
1854                 return status;
1855         first = snd_buf->page_base >> PAGE_SHIFT;
1856         inpages = snd_buf->pages + first;
1857         snd_buf->pages = rqstp->rq_enc_pages;
1858         snd_buf->page_base -= first << PAGE_SHIFT;
1859         /*
1860          * Give the tail its own page, in case we need extra space in the
1861          * head when wrapping:
1862          *
1863          * call_allocate() allocates twice the slack space required
1864          * by the authentication flavor to rq_callsize.
1865          * For GSS, slack is GSS_CRED_SLACK.
1866          */
1867         if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1868                 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1869                 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1870                 snd_buf->tail[0].iov_base = tmp;
1871         }
1872         maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1873         /* slack space should prevent this ever happening: */
1874         BUG_ON(snd_buf->len > snd_buf->buflen);
1875         status = -EIO;
1876         /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1877          * done anyway, so it's safe to put the request on the wire: */
1878         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1879                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1880         else if (maj_stat)
1881                 return status;
1882
1883         *opaque_len = htonl(snd_buf->len - offset);
1884         /* guess whether we're in the head or the tail: */
1885         if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1886                 iov = snd_buf->tail;
1887         else
1888                 iov = snd_buf->head;
1889         p = iov->iov_base + iov->iov_len;
1890         pad = 3 - ((snd_buf->len - offset - 1) & 3);
1891         memset(p, 0, pad);
1892         iov->iov_len += pad;
1893         snd_buf->len += pad;
1894
1895         return 0;
1896 }
1897
1898 static int
1899 gss_wrap_req(struct rpc_task *task,
1900              kxdreproc_t encode, void *rqstp, __be32 *p, void *obj)
1901 {
1902         struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1903         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1904                         gc_base);
1905         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1906         int             status = -EIO;
1907
1908         dprintk("RPC: %5u %s\n", task->tk_pid, __func__);
1909         if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1910                 /* The spec seems a little ambiguous here, but I think that not
1911                  * wrapping context destruction requests makes the most sense.
1912                  */
1913                 gss_wrap_req_encode(encode, rqstp, p, obj);
1914                 status = 0;
1915                 goto out;
1916         }
1917         switch (gss_cred->gc_service) {
1918         case RPC_GSS_SVC_NONE:
1919                 gss_wrap_req_encode(encode, rqstp, p, obj);
1920                 status = 0;
1921                 break;
1922         case RPC_GSS_SVC_INTEGRITY:
1923                 status = gss_wrap_req_integ(cred, ctx, encode, rqstp, p, obj);
1924                 break;
1925         case RPC_GSS_SVC_PRIVACY:
1926                 status = gss_wrap_req_priv(cred, ctx, encode, rqstp, p, obj);
1927                 break;
1928         }
1929 out:
1930         gss_put_ctx(ctx);
1931         dprintk("RPC: %5u %s returning %d\n", task->tk_pid, __func__, status);
1932         return status;
1933 }
1934
1935 static inline int
1936 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1937                 struct rpc_rqst *rqstp, __be32 **p)
1938 {
1939         struct xdr_buf  *rcv_buf = &rqstp->rq_rcv_buf;
1940         struct xdr_buf integ_buf;
1941         struct xdr_netobj mic;
1942         u32 data_offset, mic_offset;
1943         u32 integ_len;
1944         u32 maj_stat;
1945         int status = -EIO;
1946
1947         integ_len = ntohl(*(*p)++);
1948         if (integ_len & 3)
1949                 return status;
1950         data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1951         mic_offset = integ_len + data_offset;
1952         if (mic_offset > rcv_buf->len)
1953                 return status;
1954         if (ntohl(*(*p)++) != rqstp->rq_seqno)
1955                 return status;
1956
1957         if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
1958                                 mic_offset - data_offset))
1959                 return status;
1960
1961         if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
1962                 return status;
1963
1964         maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1965         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1966                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1967         if (maj_stat != GSS_S_COMPLETE)
1968                 return status;
1969         return 0;
1970 }
1971
1972 static inline int
1973 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1974                 struct rpc_rqst *rqstp, __be32 **p)
1975 {
1976         struct xdr_buf  *rcv_buf = &rqstp->rq_rcv_buf;
1977         u32 offset;
1978         u32 opaque_len;
1979         u32 maj_stat;
1980         int status = -EIO;
1981
1982         opaque_len = ntohl(*(*p)++);
1983         offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
1984         if (offset + opaque_len > rcv_buf->len)
1985                 return status;
1986         /* remove padding: */
1987         rcv_buf->len = offset + opaque_len;
1988
1989         maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
1990         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1991                 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1992         if (maj_stat != GSS_S_COMPLETE)
1993                 return status;
1994         if (ntohl(*(*p)++) != rqstp->rq_seqno)
1995                 return status;
1996
1997         return 0;
1998 }
1999
2000 static int
2001 gss_unwrap_req_decode(kxdrdproc_t decode, struct rpc_rqst *rqstp,
2002                       __be32 *p, void *obj)
2003 {
2004         struct xdr_stream xdr;
2005
2006         xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
2007         return decode(rqstp, &xdr, obj);
2008 }
2009
2010 static bool
2011 gss_seq_is_newer(u32 new, u32 old)
2012 {
2013         return (s32)(new - old) > 0;
2014 }
2015
2016 static bool
2017 gss_xmit_need_reencode(struct rpc_task *task)
2018 {
2019         struct rpc_rqst *req = task->tk_rqstp;
2020         struct rpc_cred *cred = req->rq_cred;
2021         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2022         u32 win, seq_xmit;
2023         bool ret = true;
2024
2025         if (!ctx)
2026                 return true;
2027
2028         if (gss_seq_is_newer(req->rq_seqno, READ_ONCE(ctx->gc_seq)))
2029                 goto out;
2030
2031         seq_xmit = READ_ONCE(ctx->gc_seq_xmit);
2032         while (gss_seq_is_newer(req->rq_seqno, seq_xmit)) {
2033                 u32 tmp = seq_xmit;
2034
2035                 seq_xmit = cmpxchg(&ctx->gc_seq_xmit, tmp, req->rq_seqno);
2036                 if (seq_xmit == tmp) {
2037                         ret = false;
2038                         goto out;
2039                 }
2040         }
2041
2042         win = ctx->gc_win;
2043         if (win > 0)
2044                 ret = !gss_seq_is_newer(req->rq_seqno, seq_xmit - win);
2045 out:
2046         gss_put_ctx(ctx);
2047         return ret;
2048 }
2049
2050 static int
2051 gss_unwrap_resp(struct rpc_task *task,
2052                 kxdrdproc_t decode, void *rqstp, __be32 *p, void *obj)
2053 {
2054         struct rpc_cred *cred = task->tk_rqstp->rq_cred;
2055         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
2056                         gc_base);
2057         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2058         __be32          *savedp = p;
2059         struct kvec     *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
2060         int             savedlen = head->iov_len;
2061         int             status = -EIO;
2062
2063         if (ctx->gc_proc != RPC_GSS_PROC_DATA)
2064                 goto out_decode;
2065         switch (gss_cred->gc_service) {
2066         case RPC_GSS_SVC_NONE:
2067                 break;
2068         case RPC_GSS_SVC_INTEGRITY:
2069                 status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
2070                 if (status)
2071                         goto out;
2072                 break;
2073         case RPC_GSS_SVC_PRIVACY:
2074                 status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
2075                 if (status)
2076                         goto out;
2077                 break;
2078         }
2079         /* take into account extra slack for integrity and privacy cases: */
2080         cred->cr_auth->au_rslack = cred->cr_auth->au_verfsize + (p - savedp)
2081                                                 + (savedlen - head->iov_len);
2082 out_decode:
2083         status = gss_unwrap_req_decode(decode, rqstp, p, obj);
2084 out:
2085         gss_put_ctx(ctx);
2086         dprintk("RPC: %5u %s returning %d\n",
2087                 task->tk_pid, __func__, status);
2088         return status;
2089 }
2090
2091 static const struct rpc_authops authgss_ops = {
2092         .owner          = THIS_MODULE,
2093         .au_flavor      = RPC_AUTH_GSS,
2094         .au_name        = "RPCSEC_GSS",
2095         .create         = gss_create,
2096         .destroy        = gss_destroy,
2097         .hash_cred      = gss_hash_cred,
2098         .lookup_cred    = gss_lookup_cred,
2099         .crcreate       = gss_create_cred,
2100         .list_pseudoflavors = gss_mech_list_pseudoflavors,
2101         .info2flavor    = gss_mech_info2flavor,
2102         .flavor2info    = gss_mech_flavor2info,
2103 };
2104
2105 static const struct rpc_credops gss_credops = {
2106         .cr_name                = "AUTH_GSS",
2107         .crdestroy              = gss_destroy_cred,
2108         .cr_init                = gss_cred_init,
2109         .crbind                 = rpcauth_generic_bind_cred,
2110         .crmatch                = gss_match,
2111         .crmarshal              = gss_marshal,
2112         .crrefresh              = gss_refresh,
2113         .crvalidate             = gss_validate,
2114         .crwrap_req             = gss_wrap_req,
2115         .crunwrap_resp          = gss_unwrap_resp,
2116         .crkey_timeout          = gss_key_timeout,
2117         .crstringify_acceptor   = gss_stringify_acceptor,
2118         .crneed_reencode        = gss_xmit_need_reencode,
2119 };
2120
2121 static const struct rpc_credops gss_nullops = {
2122         .cr_name                = "AUTH_GSS",
2123         .crdestroy              = gss_destroy_nullcred,
2124         .crbind                 = rpcauth_generic_bind_cred,
2125         .crmatch                = gss_match,
2126         .crmarshal              = gss_marshal,
2127         .crrefresh              = gss_refresh_null,
2128         .crvalidate             = gss_validate,
2129         .crwrap_req             = gss_wrap_req,
2130         .crunwrap_resp          = gss_unwrap_resp,
2131         .crstringify_acceptor   = gss_stringify_acceptor,
2132 };
2133
2134 static const struct rpc_pipe_ops gss_upcall_ops_v0 = {
2135         .upcall         = rpc_pipe_generic_upcall,
2136         .downcall       = gss_pipe_downcall,
2137         .destroy_msg    = gss_pipe_destroy_msg,
2138         .open_pipe      = gss_pipe_open_v0,
2139         .release_pipe   = gss_pipe_release,
2140 };
2141
2142 static const struct rpc_pipe_ops gss_upcall_ops_v1 = {
2143         .upcall         = rpc_pipe_generic_upcall,
2144         .downcall       = gss_pipe_downcall,
2145         .destroy_msg    = gss_pipe_destroy_msg,
2146         .open_pipe      = gss_pipe_open_v1,
2147         .release_pipe   = gss_pipe_release,
2148 };
2149
2150 static __net_init int rpcsec_gss_init_net(struct net *net)
2151 {
2152         return gss_svc_init_net(net);
2153 }
2154
2155 static __net_exit void rpcsec_gss_exit_net(struct net *net)
2156 {
2157         gss_svc_shutdown_net(net);
2158 }
2159
2160 static struct pernet_operations rpcsec_gss_net_ops = {
2161         .init = rpcsec_gss_init_net,
2162         .exit = rpcsec_gss_exit_net,
2163 };
2164
2165 /*
2166  * Initialize RPCSEC_GSS module
2167  */
2168 static int __init init_rpcsec_gss(void)
2169 {
2170         int err = 0;
2171
2172         err = rpcauth_register(&authgss_ops);
2173         if (err)
2174                 goto out;
2175         err = gss_svc_init();
2176         if (err)
2177                 goto out_unregister;
2178         err = register_pernet_subsys(&rpcsec_gss_net_ops);
2179         if (err)
2180                 goto out_svc_exit;
2181         rpc_init_wait_queue(&pipe_version_rpc_waitqueue, "gss pipe version");
2182         return 0;
2183 out_svc_exit:
2184         gss_svc_shutdown();
2185 out_unregister:
2186         rpcauth_unregister(&authgss_ops);
2187 out:
2188         return err;
2189 }
2190
2191 static void __exit exit_rpcsec_gss(void)
2192 {
2193         unregister_pernet_subsys(&rpcsec_gss_net_ops);
2194         gss_svc_shutdown();
2195         rpcauth_unregister(&authgss_ops);
2196         rcu_barrier(); /* Wait for completion of call_rcu()'s */
2197 }
2198
2199 MODULE_ALIAS("rpc-auth-6");
2200 MODULE_LICENSE("GPL");
2201 module_param_named(expired_cred_retry_delay,
2202                    gss_expired_cred_retry_delay,
2203                    uint, 0644);
2204 MODULE_PARM_DESC(expired_cred_retry_delay, "Timeout (in seconds) until "
2205                 "the RPC engine retries an expired credential");
2206
2207 module_param_named(key_expire_timeo,
2208                    gss_key_expire_timeo,
2209                    uint, 0644);
2210 MODULE_PARM_DESC(key_expire_timeo, "Time (in seconds) at the end of a "
2211                 "credential keys lifetime where the NFS layer cleans up "
2212                 "prior to key expiration");
2213
2214 module_init(init_rpcsec_gss)
2215 module_exit(exit_rpcsec_gss)