2  * linux/net/sunrpc/auth_gss.c
 
   4  * RPCSEC_GSS client authentication.
 
   6  *  Copyright (c) 2000 The Regents of the University of Michigan.
 
   9  *  Dug Song       <dugsong@monkey.org>
 
  10  *  Andy Adamson   <andros@umich.edu>
 
  12  *  Redistribution and use in source and binary forms, with or without
 
  13  *  modification, are permitted provided that the following conditions
 
  16  *  1. Redistributions of source code must retain the above copyright
 
  17  *     notice, this list of conditions and the following disclaimer.
 
  18  *  2. Redistributions in binary form must reproduce the above copyright
 
  19  *     notice, this list of conditions and the following disclaimer in the
 
  20  *     documentation and/or other materials provided with the distribution.
 
  21  *  3. Neither the name of the University nor the names of its
 
  22  *     contributors may be used to endorse or promote products derived
 
  23  *     from this software without specific prior written permission.
 
  25  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
 
  26  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 
  27  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
  28  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 
  29  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 
  30  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 
  31  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 
  32  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 
  33  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 
  34  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 
  35  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
  41 #include <linux/module.h>
 
  42 #include <linux/init.h>
 
  43 #include <linux/types.h>
 
  44 #include <linux/slab.h>
 
  45 #include <linux/sched.h>
 
  46 #include <linux/pagemap.h>
 
  47 #include <linux/sunrpc/clnt.h>
 
  48 #include <linux/sunrpc/auth.h>
 
  49 #include <linux/sunrpc/auth_gss.h>
 
  50 #include <linux/sunrpc/svcauth_gss.h>
 
  51 #include <linux/sunrpc/gss_err.h>
 
  52 #include <linux/workqueue.h>
 
  53 #include <linux/sunrpc/rpc_pipe_fs.h>
 
  54 #include <linux/sunrpc/gss_api.h>
 
  55 #include <asm/uaccess.h>
 
  57 static struct rpc_authops authgss_ops;
 
  59 static struct rpc_credops gss_credops;
 
  62 # define RPCDBG_FACILITY        RPCDBG_AUTH
 
  65 #define NFS_NGROUPS     16
 
  67 #define GSS_CRED_EXPIRE         (60 * HZ)       /* XXX: reasonable? */
 
  68 #define GSS_CRED_SLACK          1024            /* XXX: unused */
 
  69 /* length of a krb5 verifier (48), plus data added before arguments when
 
  70  * using integrity (two 4-byte integers): */
 
  71 #define GSS_VERF_SLACK          56
 
  73 /* XXX this define must match the gssd define
 
  74 * as it is passed to gssd to signal the use of
 
  75 * machine creds should be part of the shared rpc interface */
 
  77 #define CA_RUN_AS_MACHINE  0x00000200 
 
  79 /* dump the buffer in `emacs-hexl' style */
 
  80 #define isprint(c)      ((c > 0x1f) && (c < 0x7f))
 
  82 static DEFINE_RWLOCK(gss_ctx_lock);
 
  85         struct rpc_auth rpc_auth;
 
  86         struct gss_api_mech *mech;
 
  87         enum rpc_gss_svc service;
 
  88         struct list_head upcalls;
 
  89         struct rpc_clnt *client;
 
  90         struct dentry *dentry;
 
  95 static void gss_destroy_ctx(struct gss_cl_ctx *);
 
  96 static struct rpc_pipe_ops gss_upcall_ops;
 
  99 print_hexl(u32 *p, u_int length, u_int offset)
 
 104         dprintk("RPC: print_hexl: length %d\n",length);
 
 108         for (i = 0; i < length; i += 0x10) {
 
 109                 dprintk("  %04x: ", (u_int)(i + offset));
 
 111                 jm = jm > 16 ? 16 : jm;
 
 113                 for (j = 0; j < jm; j++) {
 
 115                                 dprintk("%02x ", (u_int)cp[i+j]);
 
 117                                 dprintk("%02x", (u_int)cp[i+j]);
 
 119                 for (; j < 16; j++) {
 
 127                 for (j = 0; j < jm; j++) {
 
 129                         c = isprint(c) ? c : '.';
 
 136 EXPORT_SYMBOL(print_hexl);
 
 138 static inline struct gss_cl_ctx *
 
 139 gss_get_ctx(struct gss_cl_ctx *ctx)
 
 141         atomic_inc(&ctx->count);
 
 146 gss_put_ctx(struct gss_cl_ctx *ctx)
 
 148         if (atomic_dec_and_test(&ctx->count))
 
 149                 gss_destroy_ctx(ctx);
 
 153 gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
 
 155         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
 
 156         struct gss_cl_ctx *old;
 
 157         write_lock(&gss_ctx_lock);
 
 158         old = gss_cred->gc_ctx;
 
 159         gss_cred->gc_ctx = ctx;
 
 160         cred->cr_flags |= RPCAUTH_CRED_UPTODATE;
 
 161         cred->cr_flags &= ~RPCAUTH_CRED_NEW;
 
 162         write_unlock(&gss_ctx_lock);
 
 168 gss_cred_is_uptodate_ctx(struct rpc_cred *cred)
 
 170         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
 
 173         read_lock(&gss_ctx_lock);
 
 174         if ((cred->cr_flags & RPCAUTH_CRED_UPTODATE) && gss_cred->gc_ctx)
 
 176         read_unlock(&gss_ctx_lock);
 
 181 simple_get_bytes(const void *p, const void *end, void *res, size_t len)
 
 183         const void *q = (const void *)((const char *)p + len);
 
 184         if (unlikely(q > end || q < p))
 
 185                 return ERR_PTR(-EFAULT);
 
 190 static inline const void *
 
 191 simple_get_netobj(const void *p, const void *end, struct xdr_netobj *dest)
 
 196         p = simple_get_bytes(p, end, &len, sizeof(len));
 
 199         q = (const void *)((const char *)p + len);
 
 200         if (unlikely(q > end || q < p))
 
 201                 return ERR_PTR(-EFAULT);
 
 202         dest->data = kmalloc(len, GFP_KERNEL);
 
 203         if (unlikely(dest->data == NULL))
 
 204                 return ERR_PTR(-ENOMEM);
 
 206         memcpy(dest->data, p, len);
 
 210 static struct gss_cl_ctx *
 
 211 gss_cred_get_ctx(struct rpc_cred *cred)
 
 213         struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
 
 214         struct gss_cl_ctx *ctx = NULL;
 
 216         read_lock(&gss_ctx_lock);
 
 217         if (gss_cred->gc_ctx)
 
 218                 ctx = gss_get_ctx(gss_cred->gc_ctx);
 
 219         read_unlock(&gss_ctx_lock);
 
 223 static struct gss_cl_ctx *
 
 224 gss_alloc_context(void)
 
 226         struct gss_cl_ctx *ctx;
 
 228         ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
 
 230                 memset(ctx, 0, sizeof(*ctx));
 
 231                 ctx->gc_proc = RPC_GSS_PROC_DATA;
 
 232                 ctx->gc_seq = 1;        /* NetApp 6.4R1 doesn't accept seq. no. 0 */
 
 233                 spin_lock_init(&ctx->gc_seq_lock);
 
 234                 atomic_set(&ctx->count,1);
 
 239 #define GSSD_MIN_TIMEOUT (60 * 60)
 
 241 gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
 
 245         unsigned int timeout;
 
 249         /* First unsigned int gives the lifetime (in seconds) of the cred */
 
 250         p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
 
 254                 timeout = GSSD_MIN_TIMEOUT;
 
 255         ctx->gc_expiry = jiffies + (unsigned long)timeout * HZ * 3 / 4;
 
 256         /* Sequence number window. Determines the maximum number of simultaneous requests */
 
 257         p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
 
 260         ctx->gc_win = window_size;
 
 261         /* gssd signals an error by passing ctx->gc_win = 0: */
 
 262         if (ctx->gc_win == 0) {
 
 263                 /* in which case, p points to  an error code which we ignore */
 
 264                 p = ERR_PTR(-EACCES);
 
 267         /* copy the opaque wire context */
 
 268         p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
 
 271         /* import the opaque security context */
 
 272         p  = simple_get_bytes(p, end, &seclen, sizeof(seclen));
 
 275         q = (const void *)((const char *)p + seclen);
 
 276         if (unlikely(q > end || q < p)) {
 
 277                 p = ERR_PTR(-EFAULT);
 
 280         ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx);
 
 287         dprintk("RPC:      gss_fill_context returning %ld\n", -PTR_ERR(p));
 
 292 struct gss_upcall_msg {
 
 295         struct rpc_pipe_msg msg;
 
 296         struct list_head list;
 
 297         struct gss_auth *auth;
 
 298         struct rpc_wait_queue rpc_waitqueue;
 
 299         wait_queue_head_t waitqueue;
 
 300         struct gss_cl_ctx *ctx;
 
 304 gss_release_msg(struct gss_upcall_msg *gss_msg)
 
 306         if (!atomic_dec_and_test(&gss_msg->count))
 
 308         BUG_ON(!list_empty(&gss_msg->list));
 
 309         if (gss_msg->ctx != NULL)
 
 310                 gss_put_ctx(gss_msg->ctx);
 
 314 static struct gss_upcall_msg *
 
 315 __gss_find_upcall(struct gss_auth *gss_auth, uid_t uid)
 
 317         struct gss_upcall_msg *pos;
 
 318         list_for_each_entry(pos, &gss_auth->upcalls, list) {
 
 321                 atomic_inc(&pos->count);
 
 322                 dprintk("RPC:      gss_find_upcall found msg %p\n", pos);
 
 325         dprintk("RPC:      gss_find_upcall found nothing\n");
 
 329 /* Try to add a upcall to the pipefs queue.
 
 330  * If an upcall owned by our uid already exists, then we return a reference
 
 331  * to that upcall instead of adding the new upcall.
 
 333 static inline struct gss_upcall_msg *
 
 334 gss_add_msg(struct gss_auth *gss_auth, struct gss_upcall_msg *gss_msg)
 
 336         struct gss_upcall_msg *old;
 
 338         spin_lock(&gss_auth->lock);
 
 339         old = __gss_find_upcall(gss_auth, gss_msg->uid);
 
 341                 atomic_inc(&gss_msg->count);
 
 342                 list_add(&gss_msg->list, &gss_auth->upcalls);
 
 345         spin_unlock(&gss_auth->lock);
 
 350 __gss_unhash_msg(struct gss_upcall_msg *gss_msg)
 
 352         if (list_empty(&gss_msg->list))
 
 354         list_del_init(&gss_msg->list);
 
 355         rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
 
 356         wake_up_all(&gss_msg->waitqueue);
 
 357         atomic_dec(&gss_msg->count);
 
 361 gss_unhash_msg(struct gss_upcall_msg *gss_msg)
 
 363         struct gss_auth *gss_auth = gss_msg->auth;
 
 365         spin_lock(&gss_auth->lock);
 
 366         __gss_unhash_msg(gss_msg);
 
 367         spin_unlock(&gss_auth->lock);
 
 371 gss_upcall_callback(struct rpc_task *task)
 
 373         struct gss_cred *gss_cred = container_of(task->tk_msg.rpc_cred,
 
 374                         struct gss_cred, gc_base);
 
 375         struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
 
 377         BUG_ON(gss_msg == NULL);
 
 379                 gss_cred_set_ctx(task->tk_msg.rpc_cred, gss_get_ctx(gss_msg->ctx));
 
 381                 task->tk_status = gss_msg->msg.errno;
 
 382         spin_lock(&gss_msg->auth->lock);
 
 383         gss_cred->gc_upcall = NULL;
 
 384         rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
 
 385         spin_unlock(&gss_msg->auth->lock);
 
 386         gss_release_msg(gss_msg);
 
 389 static inline struct gss_upcall_msg *
 
 390 gss_alloc_msg(struct gss_auth *gss_auth, uid_t uid)
 
 392         struct gss_upcall_msg *gss_msg;
 
 394         gss_msg = kmalloc(sizeof(*gss_msg), GFP_KERNEL);
 
 395         if (gss_msg != NULL) {
 
 396                 memset(gss_msg, 0, sizeof(*gss_msg));
 
 397                 INIT_LIST_HEAD(&gss_msg->list);
 
 398                 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
 
 399                 init_waitqueue_head(&gss_msg->waitqueue);
 
 400                 atomic_set(&gss_msg->count, 1);
 
 401                 gss_msg->msg.data = &gss_msg->uid;
 
 402                 gss_msg->msg.len = sizeof(gss_msg->uid);
 
 404                 gss_msg->auth = gss_auth;
 
 409 static struct gss_upcall_msg *
 
 410 gss_setup_upcall(struct rpc_clnt *clnt, struct gss_auth *gss_auth, struct rpc_cred *cred)
 
 412         struct gss_upcall_msg *gss_new, *gss_msg;
 
 414         gss_new = gss_alloc_msg(gss_auth, cred->cr_uid);
 
 416                 return ERR_PTR(-ENOMEM);
 
 417         gss_msg = gss_add_msg(gss_auth, gss_new);
 
 418         if (gss_msg == gss_new) {
 
 419                 int res = rpc_queue_upcall(gss_auth->dentry->d_inode, &gss_new->msg);
 
 421                         gss_unhash_msg(gss_new);
 
 422                         gss_msg = ERR_PTR(res);
 
 425                 gss_release_msg(gss_new);
 
 430 gss_refresh_upcall(struct rpc_task *task)
 
 432         struct rpc_cred *cred = task->tk_msg.rpc_cred;
 
 433         struct gss_auth *gss_auth = container_of(task->tk_client->cl_auth,
 
 434                         struct gss_auth, rpc_auth);
 
 435         struct gss_cred *gss_cred = container_of(cred,
 
 436                         struct gss_cred, gc_base);
 
 437         struct gss_upcall_msg *gss_msg;
 
 440         dprintk("RPC: %4u gss_refresh_upcall for uid %u\n", task->tk_pid, cred->cr_uid);
 
 441         gss_msg = gss_setup_upcall(task->tk_client, gss_auth, cred);
 
 442         if (IS_ERR(gss_msg)) {
 
 443                 err = PTR_ERR(gss_msg);
 
 446         spin_lock(&gss_auth->lock);
 
 447         if (gss_cred->gc_upcall != NULL)
 
 448                 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL, NULL);
 
 449         else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
 
 450                 task->tk_timeout = 0;
 
 451                 gss_cred->gc_upcall = gss_msg;
 
 452                 /* gss_upcall_callback will release the reference to gss_upcall_msg */
 
 453                 atomic_inc(&gss_msg->count);
 
 454                 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback, NULL);
 
 456                 err = gss_msg->msg.errno;
 
 457         spin_unlock(&gss_auth->lock);
 
 458         gss_release_msg(gss_msg);
 
 460         dprintk("RPC: %4u gss_refresh_upcall for uid %u result %d\n", task->tk_pid,
 
 466 gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
 
 468         struct rpc_cred *cred = &gss_cred->gc_base;
 
 469         struct gss_upcall_msg *gss_msg;
 
 473         dprintk("RPC: gss_upcall for uid %u\n", cred->cr_uid);
 
 474         gss_msg = gss_setup_upcall(gss_auth->client, gss_auth, cred);
 
 475         if (IS_ERR(gss_msg)) {
 
 476                 err = PTR_ERR(gss_msg);
 
 480                 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_INTERRUPTIBLE);
 
 481                 spin_lock(&gss_auth->lock);
 
 482                 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
 
 483                         spin_unlock(&gss_auth->lock);
 
 486                 spin_unlock(&gss_auth->lock);
 
 494                 gss_cred_set_ctx(cred, gss_get_ctx(gss_msg->ctx));
 
 496                 err = gss_msg->msg.errno;
 
 498         finish_wait(&gss_msg->waitqueue, &wait);
 
 499         gss_release_msg(gss_msg);
 
 501         dprintk("RPC: gss_create_upcall for uid %u result %d\n", cred->cr_uid, err);
 
 506 gss_pipe_upcall(struct file *filp, struct rpc_pipe_msg *msg,
 
 507                 char __user *dst, size_t buflen)
 
 509         char *data = (char *)msg->data + msg->copied;
 
 510         ssize_t mlen = msg->len;
 
 515         left = copy_to_user(dst, data, mlen);
 
 526 #define MSG_BUF_MAXSIZE 1024
 
 529 gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
 
 533         struct rpc_clnt *clnt;
 
 534         struct gss_auth *gss_auth;
 
 535         struct rpc_cred *cred;
 
 536         struct gss_upcall_msg *gss_msg;
 
 537         struct gss_cl_ctx *ctx;
 
 541         if (mlen > MSG_BUF_MAXSIZE)
 
 544         buf = kmalloc(mlen, GFP_KERNEL);
 
 548         clnt = RPC_I(filp->f_dentry->d_inode)->private;
 
 550         if (copy_from_user(buf, src, mlen))
 
 553         end = (const void *)((char *)buf + mlen);
 
 554         p = simple_get_bytes(buf, end, &uid, sizeof(uid));
 
 561         ctx = gss_alloc_context();
 
 565         gss_auth = container_of(clnt->cl_auth, struct gss_auth, rpc_auth);
 
 566         p = gss_fill_context(p, end, ctx, gss_auth->mech);
 
 572         spin_lock(&gss_auth->lock);
 
 573         gss_msg = __gss_find_upcall(gss_auth, uid);
 
 575                 if (err == 0 && gss_msg->ctx == NULL)
 
 576                         gss_msg->ctx = gss_get_ctx(ctx);
 
 577                 gss_msg->msg.errno = err;
 
 578                 __gss_unhash_msg(gss_msg);
 
 579                 spin_unlock(&gss_auth->lock);
 
 580                 gss_release_msg(gss_msg);
 
 582                 struct auth_cred acred = { .uid = uid };
 
 583                 spin_unlock(&gss_auth->lock);
 
 584                 cred = rpcauth_lookup_credcache(clnt->cl_auth, &acred, RPCAUTH_LOOKUP_NEW);
 
 589                 gss_cred_set_ctx(cred, gss_get_ctx(ctx));
 
 593         dprintk("RPC:      gss_pipe_downcall returning length %Zu\n", mlen);
 
 600         dprintk("RPC:      gss_pipe_downcall returning %d\n", err);
 
 605 gss_pipe_release(struct inode *inode)
 
 607         struct rpc_inode *rpci = RPC_I(inode);
 
 608         struct rpc_clnt *clnt;
 
 609         struct rpc_auth *auth;
 
 610         struct gss_auth *gss_auth;
 
 612         clnt = rpci->private;
 
 613         auth = clnt->cl_auth;
 
 614         gss_auth = container_of(auth, struct gss_auth, rpc_auth);
 
 615         spin_lock(&gss_auth->lock);
 
 616         while (!list_empty(&gss_auth->upcalls)) {
 
 617                 struct gss_upcall_msg *gss_msg;
 
 619                 gss_msg = list_entry(gss_auth->upcalls.next,
 
 620                                 struct gss_upcall_msg, list);
 
 621                 gss_msg->msg.errno = -EPIPE;
 
 622                 atomic_inc(&gss_msg->count);
 
 623                 __gss_unhash_msg(gss_msg);
 
 624                 spin_unlock(&gss_auth->lock);
 
 625                 gss_release_msg(gss_msg);
 
 626                 spin_lock(&gss_auth->lock);
 
 628         spin_unlock(&gss_auth->lock);
 
 632 gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
 
 634         struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
 
 635         static unsigned long ratelimit;
 
 637         if (msg->errno < 0) {
 
 638                 dprintk("RPC:      gss_pipe_destroy_msg releasing msg %p\n",
 
 640                 atomic_inc(&gss_msg->count);
 
 641                 gss_unhash_msg(gss_msg);
 
 642                 if (msg->errno == -ETIMEDOUT) {
 
 643                         unsigned long now = jiffies;
 
 644                         if (time_after(now, ratelimit)) {
 
 645                                 printk(KERN_WARNING "RPC: AUTH_GSS upcall timed out.\n"
 
 646                                                     "Please check user daemon is running!\n");
 
 647                                 ratelimit = now + 15*HZ;
 
 650                 gss_release_msg(gss_msg);
 
 655  * NOTE: we have the opportunity to use different 
 
 656  * parameters based on the input flavor (which must be a pseudoflavor)
 
 658 static struct rpc_auth *
 
 659 gss_create(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
 
 661         struct gss_auth *gss_auth;
 
 662         struct rpc_auth * auth;
 
 663         int err = -ENOMEM; /* XXX? */
 
 665         dprintk("RPC:      creating GSS authenticator for client %p\n",clnt);
 
 667         if (!try_module_get(THIS_MODULE))
 
 669         if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
 
 671         gss_auth->client = clnt;
 
 673         gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
 
 674         if (!gss_auth->mech) {
 
 675                 printk(KERN_WARNING "%s: Pseudoflavor %d not found!",
 
 676                                 __FUNCTION__, flavor);
 
 679         gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
 
 680         if (gss_auth->service == 0)
 
 682         INIT_LIST_HEAD(&gss_auth->upcalls);
 
 683         spin_lock_init(&gss_auth->lock);
 
 684         auth = &gss_auth->rpc_auth;
 
 685         auth->au_cslack = GSS_CRED_SLACK >> 2;
 
 686         auth->au_rslack = GSS_VERF_SLACK >> 2;
 
 687         auth->au_ops = &authgss_ops;
 
 688         auth->au_flavor = flavor;
 
 689         atomic_set(&auth->au_count, 1);
 
 691         err = rpcauth_init_credcache(auth, GSS_CRED_EXPIRE);
 
 695         snprintf(gss_auth->path, sizeof(gss_auth->path), "%s/%s",
 
 697                         gss_auth->mech->gm_name);
 
 698         gss_auth->dentry = rpc_mkpipe(gss_auth->path, clnt, &gss_upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
 
 699         if (IS_ERR(gss_auth->dentry)) {
 
 700                 err = PTR_ERR(gss_auth->dentry);
 
 706         gss_mech_put(gss_auth->mech);
 
 710         module_put(THIS_MODULE);
 
 715 gss_destroy(struct rpc_auth *auth)
 
 717         struct gss_auth *gss_auth;
 
 719         dprintk("RPC:      destroying GSS authenticator %p flavor %d\n",
 
 720                 auth, auth->au_flavor);
 
 722         gss_auth = container_of(auth, struct gss_auth, rpc_auth);
 
 723         rpc_unlink(gss_auth->path);
 
 724         gss_mech_put(gss_auth->mech);
 
 726         rpcauth_free_credcache(auth);
 
 728         module_put(THIS_MODULE);
 
 731 /* gss_destroy_cred (and gss_destroy_ctx) are used to clean up after failure
 
 732  * to create a new cred or context, so they check that things have been
 
 733  * allocated before freeing them. */
 
 735 gss_destroy_ctx(struct gss_cl_ctx *ctx)
 
 737         dprintk("RPC:      gss_destroy_ctx\n");
 
 740                 gss_delete_sec_context(&ctx->gc_gss_ctx);
 
 742         kfree(ctx->gc_wire_ctx.data);
 
 747 gss_destroy_cred(struct rpc_cred *rc)
 
 749         struct gss_cred *cred = container_of(rc, struct gss_cred, gc_base);
 
 751         dprintk("RPC:      gss_destroy_cred \n");
 
 754                 gss_put_ctx(cred->gc_ctx);
 
 759  * Lookup RPCSEC_GSS cred for the current process
 
 761 static struct rpc_cred *
 
 762 gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
 
 764         return rpcauth_lookup_credcache(auth, acred, flags);
 
 767 static struct rpc_cred *
 
 768 gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
 
 770         struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
 
 771         struct gss_cred *cred = NULL;
 
 774         dprintk("RPC:      gss_create_cred for uid %d, flavor %d\n",
 
 775                 acred->uid, auth->au_flavor);
 
 777         if (!(cred = kmalloc(sizeof(*cred), GFP_KERNEL)))
 
 780         memset(cred, 0, sizeof(*cred));
 
 781         atomic_set(&cred->gc_count, 1);
 
 782         cred->gc_uid = acred->uid;
 
 784          * Note: in order to force a call to call_refresh(), we deliberately
 
 785          * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
 
 788         cred->gc_base.cr_ops = &gss_credops;
 
 789         cred->gc_base.cr_flags = RPCAUTH_CRED_NEW;
 
 790         cred->gc_service = gss_auth->service;
 
 791         return &cred->gc_base;
 
 794         dprintk("RPC:      gss_create_cred failed with error %d\n", err);
 
 795         if (cred) gss_destroy_cred(&cred->gc_base);
 
 800 gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
 
 802         struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
 
 803         struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
 
 807                 err = gss_create_upcall(gss_auth, gss_cred);
 
 808         } while (err == -EAGAIN);
 
 813 gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
 
 815         struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
 
 818          * If the searchflags have set RPCAUTH_LOOKUP_NEW, then
 
 819          * we don't really care if the credential has expired or not,
 
 820          * since the caller should be prepared to reinitialise it.
 
 822         if ((flags & RPCAUTH_LOOKUP_NEW) && (rc->cr_flags & RPCAUTH_CRED_NEW))
 
 824         /* Don't match with creds that have expired. */
 
 825         if (gss_cred->gc_ctx && time_after(jiffies, gss_cred->gc_ctx->gc_expiry))
 
 828         return (rc->cr_uid == acred->uid);
 
 832 * Marshal credentials.
 
 833 * Maybe we should keep a cached credential for performance reasons.
 
 836 gss_marshal(struct rpc_task *task, u32 *p)
 
 838         struct rpc_cred *cred = task->tk_msg.rpc_cred;
 
 839         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
 
 841         struct gss_cl_ctx       *ctx = gss_cred_get_ctx(cred);
 
 843         struct rpc_rqst *req = task->tk_rqstp;
 
 845         struct xdr_netobj mic;
 
 847         struct xdr_buf  verf_buf;
 
 849         dprintk("RPC: %4u gss_marshal\n", task->tk_pid);
 
 851         *p++ = htonl(RPC_AUTH_GSS);
 
 854         spin_lock(&ctx->gc_seq_lock);
 
 855         req->rq_seqno = ctx->gc_seq++;
 
 856         spin_unlock(&ctx->gc_seq_lock);
 
 858         *p++ = htonl((u32) RPC_GSS_VERSION);
 
 859         *p++ = htonl((u32) ctx->gc_proc);
 
 860         *p++ = htonl((u32) req->rq_seqno);
 
 861         *p++ = htonl((u32) gss_cred->gc_service);
 
 862         p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
 
 863         *cred_len = htonl((p - (cred_len + 1)) << 2);
 
 865         /* We compute the checksum for the verifier over the xdr-encoded bytes
 
 866          * starting with the xid and ending at the end of the credential: */
 
 867         iov.iov_base = xprt_skip_transport_header(task->tk_xprt,
 
 868                                         req->rq_snd_buf.head[0].iov_base);
 
 869         iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
 
 870         xdr_buf_from_iov(&iov, &verf_buf);
 
 872         /* set verifier flavor*/
 
 873         *p++ = htonl(RPC_AUTH_GSS);
 
 875         mic.data = (u8 *)(p + 1);
 
 876         maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
 
 877         if (maj_stat == GSS_S_CONTEXT_EXPIRED) {
 
 878                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
 879         } else if (maj_stat != 0) {
 
 880                 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat);
 
 883         p = xdr_encode_opaque(p, NULL, mic.len);
 
 892 * Refresh credentials. XXX - finish
 
 895 gss_refresh(struct rpc_task *task)
 
 898         if (!gss_cred_is_uptodate_ctx(task->tk_msg.rpc_cred))
 
 899                 return gss_refresh_upcall(task);
 
 904 gss_validate(struct rpc_task *task, u32 *p)
 
 906         struct rpc_cred *cred = task->tk_msg.rpc_cred;
 
 907         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
 
 910         struct xdr_buf  verf_buf;
 
 911         struct xdr_netobj mic;
 
 915         dprintk("RPC: %4u gss_validate\n", task->tk_pid);
 
 918         if ((len = ntohl(*p++)) > RPC_MAX_AUTH_SIZE)
 
 920         if (flav != RPC_AUTH_GSS)
 
 922         seq = htonl(task->tk_rqstp->rq_seqno);
 
 924         iov.iov_len = sizeof(seq);
 
 925         xdr_buf_from_iov(&iov, &verf_buf);
 
 929         maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
 
 930         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
 
 931                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
 934         /* We leave it to unwrap to calculate au_rslack. For now we just
 
 935          * calculate the length of the verifier: */
 
 936         task->tk_auth->au_verfsize = XDR_QUADLEN(len) + 2;
 
 938         dprintk("RPC: %4u GSS gss_validate: gss_verify_mic succeeded.\n",
 
 940         return p + XDR_QUADLEN(len);
 
 943         dprintk("RPC: %4u gss_validate failed.\n", task->tk_pid);
 
 948 gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
 
 949                 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
 
 951         struct xdr_buf  *snd_buf = &rqstp->rq_snd_buf;
 
 952         struct xdr_buf  integ_buf;
 
 953         u32             *integ_len = NULL;
 
 954         struct xdr_netobj mic;
 
 961         offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
 
 962         *p++ = htonl(rqstp->rq_seqno);
 
 964         status = encode(rqstp, p, obj);
 
 968         if (xdr_buf_subsegment(snd_buf, &integ_buf,
 
 969                                 offset, snd_buf->len - offset))
 
 971         *integ_len = htonl(integ_buf.len);
 
 973         /* guess whether we're in the head or the tail: */
 
 974         if (snd_buf->page_len || snd_buf->tail[0].iov_len) 
 
 978         p = iov->iov_base + iov->iov_len;
 
 979         mic.data = (u8 *)(p + 1);
 
 981         maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
 
 982         status = -EIO; /* XXX? */
 
 983         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
 
 984                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
 987         q = xdr_encode_opaque(p, NULL, mic.len);
 
 989         offset = (u8 *)q - (u8 *)p;
 
 990         iov->iov_len += offset;
 
 991         snd_buf->len += offset;
 
 996 priv_release_snd_buf(struct rpc_rqst *rqstp)
 
1000         for (i=0; i < rqstp->rq_enc_pages_num; i++)
 
1001                 __free_page(rqstp->rq_enc_pages[i]);
 
1002         kfree(rqstp->rq_enc_pages);
 
1006 alloc_enc_pages(struct rpc_rqst *rqstp)
 
1008         struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
 
1011         if (snd_buf->page_len == 0) {
 
1012                 rqstp->rq_enc_pages_num = 0;
 
1016         first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
 
1017         last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_CACHE_SHIFT;
 
1018         rqstp->rq_enc_pages_num = last - first + 1 + 1;
 
1020                 = kmalloc(rqstp->rq_enc_pages_num * sizeof(struct page *),
 
1022         if (!rqstp->rq_enc_pages)
 
1024         for (i=0; i < rqstp->rq_enc_pages_num; i++) {
 
1025                 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
 
1026                 if (rqstp->rq_enc_pages[i] == NULL)
 
1029         rqstp->rq_release_snd_buf = priv_release_snd_buf;
 
1032         for (i--; i >= 0; i--) {
 
1033                 __free_page(rqstp->rq_enc_pages[i]);
 
1040 gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
 
1041                 kxdrproc_t encode, struct rpc_rqst *rqstp, u32 *p, void *obj)
 
1043         struct xdr_buf  *snd_buf = &rqstp->rq_snd_buf;
 
1048         struct page     **inpages;
 
1055         offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
 
1056         *p++ = htonl(rqstp->rq_seqno);
 
1058         status = encode(rqstp, p, obj);
 
1062         status = alloc_enc_pages(rqstp);
 
1065         first = snd_buf->page_base >> PAGE_CACHE_SHIFT;
 
1066         inpages = snd_buf->pages + first;
 
1067         snd_buf->pages = rqstp->rq_enc_pages;
 
1068         snd_buf->page_base -= first << PAGE_CACHE_SHIFT;
 
1069         /* Give the tail its own page, in case we need extra space in the
 
1070          * head when wrapping: */
 
1071         if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
 
1072                 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
 
1073                 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
 
1074                 snd_buf->tail[0].iov_base = tmp;
 
1076         maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
 
1077         /* RPC_SLACK_SPACE should prevent this ever happening: */
 
1078         BUG_ON(snd_buf->len > snd_buf->buflen);
 
1080         /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
 
1081          * done anyway, so it's safe to put the request on the wire: */
 
1082         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
 
1083                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
1087         *opaque_len = htonl(snd_buf->len - offset);
 
1088         /* guess whether we're in the head or the tail: */
 
1089         if (snd_buf->page_len || snd_buf->tail[0].iov_len)
 
1090                 iov = snd_buf->tail;
 
1092                 iov = snd_buf->head;
 
1093         p = iov->iov_base + iov->iov_len;
 
1094         pad = 3 - ((snd_buf->len - offset - 1) & 3);
 
1096         iov->iov_len += pad;
 
1097         snd_buf->len += pad;
 
1103 gss_wrap_req(struct rpc_task *task,
 
1104              kxdrproc_t encode, void *rqstp, u32 *p, void *obj)
 
1106         struct rpc_cred *cred = task->tk_msg.rpc_cred;
 
1107         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
 
1109         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
 
1112         dprintk("RPC: %4u gss_wrap_req\n", task->tk_pid);
 
1113         if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
 
1114                 /* The spec seems a little ambiguous here, but I think that not
 
1115                  * wrapping context destruction requests makes the most sense.
 
1117                 status = encode(rqstp, p, obj);
 
1120         switch (gss_cred->gc_service) {
 
1121                 case RPC_GSS_SVC_NONE:
 
1122                         status = encode(rqstp, p, obj);
 
1124                 case RPC_GSS_SVC_INTEGRITY:
 
1125                         status = gss_wrap_req_integ(cred, ctx, encode,
 
1128                 case RPC_GSS_SVC_PRIVACY:
 
1129                         status = gss_wrap_req_priv(cred, ctx, encode,
 
1135         dprintk("RPC: %4u gss_wrap_req returning %d\n", task->tk_pid, status);
 
1140 gss_unwrap_resp_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
 
1141                 struct rpc_rqst *rqstp, u32 **p)
 
1143         struct xdr_buf  *rcv_buf = &rqstp->rq_rcv_buf;
 
1144         struct xdr_buf integ_buf;
 
1145         struct xdr_netobj mic;
 
1146         u32 data_offset, mic_offset;
 
1151         integ_len = ntohl(*(*p)++);
 
1154         data_offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
 
1155         mic_offset = integ_len + data_offset;
 
1156         if (mic_offset > rcv_buf->len)
 
1158         if (ntohl(*(*p)++) != rqstp->rq_seqno)
 
1161         if (xdr_buf_subsegment(rcv_buf, &integ_buf, data_offset,
 
1162                                 mic_offset - data_offset))
 
1165         if (xdr_buf_read_netobj(rcv_buf, &mic, mic_offset))
 
1168         maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
 
1169         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
 
1170                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
1171         if (maj_stat != GSS_S_COMPLETE)
 
1177 gss_unwrap_resp_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
 
1178                 struct rpc_rqst *rqstp, u32 **p)
 
1180         struct xdr_buf  *rcv_buf = &rqstp->rq_rcv_buf;
 
1186         opaque_len = ntohl(*(*p)++);
 
1187         offset = (u8 *)(*p) - (u8 *)rcv_buf->head[0].iov_base;
 
1188         if (offset + opaque_len > rcv_buf->len)
 
1190         /* remove padding: */
 
1191         rcv_buf->len = offset + opaque_len;
 
1193         maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset, rcv_buf);
 
1194         if (maj_stat == GSS_S_CONTEXT_EXPIRED)
 
1195                 cred->cr_flags &= ~RPCAUTH_CRED_UPTODATE;
 
1196         if (maj_stat != GSS_S_COMPLETE)
 
1198         if (ntohl(*(*p)++) != rqstp->rq_seqno)
 
1206 gss_unwrap_resp(struct rpc_task *task,
 
1207                 kxdrproc_t decode, void *rqstp, u32 *p, void *obj)
 
1209         struct rpc_cred *cred = task->tk_msg.rpc_cred;
 
1210         struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
 
1212         struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
 
1214         struct kvec     *head = ((struct rpc_rqst *)rqstp)->rq_rcv_buf.head;
 
1215         int             savedlen = head->iov_len;
 
1218         if (ctx->gc_proc != RPC_GSS_PROC_DATA)
 
1220         switch (gss_cred->gc_service) {
 
1221                 case RPC_GSS_SVC_NONE:
 
1223                 case RPC_GSS_SVC_INTEGRITY:
 
1224                         status = gss_unwrap_resp_integ(cred, ctx, rqstp, &p);
 
1228                 case RPC_GSS_SVC_PRIVACY:
 
1229                         status = gss_unwrap_resp_priv(cred, ctx, rqstp, &p);
 
1234         /* take into account extra slack for integrity and privacy cases: */
 
1235         task->tk_auth->au_rslack = task->tk_auth->au_verfsize + (p - savedp)
 
1236                                                 + (savedlen - head->iov_len);
 
1238         status = decode(rqstp, p, obj);
 
1241         dprintk("RPC: %4u gss_unwrap_resp returning %d\n", task->tk_pid,
 
1246 static struct rpc_authops authgss_ops = {
 
1247         .owner          = THIS_MODULE,
 
1248         .au_flavor      = RPC_AUTH_GSS,
 
1250         .au_name        = "RPCSEC_GSS",
 
1252         .create         = gss_create,
 
1253         .destroy        = gss_destroy,
 
1254         .lookup_cred    = gss_lookup_cred,
 
1255         .crcreate       = gss_create_cred
 
1258 static struct rpc_credops gss_credops = {
 
1259         .cr_name        = "AUTH_GSS",
 
1260         .crdestroy      = gss_destroy_cred,
 
1261         .cr_init        = gss_cred_init,
 
1262         .crmatch        = gss_match,
 
1263         .crmarshal      = gss_marshal,
 
1264         .crrefresh      = gss_refresh,
 
1265         .crvalidate     = gss_validate,
 
1266         .crwrap_req     = gss_wrap_req,
 
1267         .crunwrap_resp  = gss_unwrap_resp,
 
1270 static struct rpc_pipe_ops gss_upcall_ops = {
 
1271         .upcall         = gss_pipe_upcall,
 
1272         .downcall       = gss_pipe_downcall,
 
1273         .destroy_msg    = gss_pipe_destroy_msg,
 
1274         .release_pipe   = gss_pipe_release,
 
1278  * Initialize RPCSEC_GSS module
 
1280 static int __init init_rpcsec_gss(void)
 
1284         err = rpcauth_register(&authgss_ops);
 
1287         err = gss_svc_init();
 
1289                 goto out_unregister;
 
1292         rpcauth_unregister(&authgss_ops);
 
1297 static void __exit exit_rpcsec_gss(void)
 
1300         rpcauth_unregister(&authgss_ops);
 
1303 MODULE_LICENSE("GPL");
 
1304 module_init(init_rpcsec_gss)
 
1305 module_exit(exit_rpcsec_gss)