lustre/ptlrpc/gss/gss_keyring.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/ptlrpc/gss/gss_keyring.c
  37  *
  38  * Author: Eric Mei <ericm@clusterfs.com>
  39  */
  40
  41 #ifndef EXPORT_SYMTAB
  42 # define EXPORT_SYMTAB
  43 #endif
  44 #define DEBUG_SUBSYSTEM S_SEC
  45 #ifdef __KERNEL__
  46 #include <linux/init.h>
  47 #include <linux/module.h>
  48 #include <linux/slab.h>
  49 #include <linux/dcache.h>
  50 #include <linux/fs.h>
  51 #include <linux/crypto.h>
  52 #include <linux/key.h>
  53 #include <linux/keyctl.h>
  54 #include <linux/mutex.h>
  55 #include <asm/atomic.h>
  56 #else
  57 #include <liblustre.h>
  58 #endif
  59
  60 #include <obd.h>
  61 #include <obd_class.h>
  62 #include <obd_support.h>
  63 #include <lustre/lustre_idl.h>
  64 #include <lustre_sec.h>
  65 #include <lustre_net.h>
  66 #include <lustre_import.h>
  67
  68 #include "gss_err.h"
  69 #include "gss_internal.h"
  70 #include "gss_api.h"
  71
  72 static struct ptlrpc_sec_policy gss_policy_keyring;
  73 static struct ptlrpc_ctx_ops gss_keyring_ctxops;
  74 static struct key_type gss_key_type;
  75
  76 static int sec_install_rctx_kr(struct ptlrpc_sec *sec,
  77                                struct ptlrpc_svc_ctx *svc_ctx);
  78
  79 /*
  80  * the timeout is only for the case that upcall child process die abnormally.
  81  * in any other cases it should finally update kernel key.
  82  *
  83  * FIXME we'd better to incorporate the client & server side upcall timeouts
  84  * into the framework of Adaptive Timeouts, but we need to figure out how to
  85  * make sure that kernel knows the upcall processes is in-progress or died
  86  * unexpectedly.
  87  */
  88 #define KEYRING_UPCALL_TIMEOUT  (obd_timeout + obd_timeout)
  89
  90 /****************************************
  91  * internal helpers                     *
  92  ****************************************/
  93
  94 #define DUMP_PROCESS_KEYRINGS(tsk)                                      \
  95 {                                                                       \
  96         CWARN("DUMP PK: %s[%u,%u/%u](<-%s[%u,%u/%u]): "                 \
  97               "a %d, t %d, p %d, s %d, u %d, us %d, df %d\n",           \
  98               tsk->comm, tsk->pid, tsk->uid, tsk->fsuid,                \
  99               tsk->parent->comm, tsk->parent->pid,                      \
 100               tsk->parent->uid, tsk->parent->fsuid,                     \
 101               tsk->request_key_auth ?                                   \
 102               tsk->request_key_auth->serial : 0,                        \
 103               tsk->thread_keyring ?                                     \
 104               tsk->thread_keyring->serial : 0,                          \
 105               tsk->signal->process_keyring ?                            \
 106               tsk->signal->process_keyring->serial : 0,                 \
 107               tsk->signal->session_keyring ?                            \
 108               tsk->signal->session_keyring->serial : 0,                 \
 109               tsk->user->uid_keyring ?                                  \
 110               tsk->user->uid_keyring->serial : 0,                       \
 111               tsk->user->session_keyring ?                              \
 112               tsk->user->session_keyring->serial : 0,                   \
 113               tsk->jit_keyring                                          \
 114              );                                                         \
 115 }
 116
 117 #define DUMP_KEY(key)                                                   \
 118 {                                                                       \
 119         CWARN("DUMP KEY: %p(%d) ref %d u%u/g%u desc %s\n",              \
 120               key, key->serial, atomic_read(&key->usage),               \
 121               key->uid, key->gid,                                       \
 122               key->description ? key->description : "n/a"               \
 123              );                                                         \
 124 }
 125
 126
 127 static inline void keyring_upcall_lock(struct gss_sec_keyring *gsec_kr)
 128 {
 129 #ifdef HAVE_KEYRING_UPCALL_SERIALIZED
 130         cfs_mutex_lock(&gsec_kr->gsk_uc_lock);
 131 #endif
 132 }
 133
 134 static inline void keyring_upcall_unlock(struct gss_sec_keyring *gsec_kr)
 135 {
 136 #ifdef HAVE_KEYRING_UPCALL_SERIALIZED
 137         cfs_mutex_unlock(&gsec_kr->gsk_uc_lock);
 138 #endif
 139 }
 140
 141 static inline void key_revoke_locked(struct key *key)
 142 {
 143         set_bit(KEY_FLAG_REVOKED, &key->flags);
 144 }
 145
 146 static void ctx_upcall_timeout_kr(unsigned long data)
 147 {
 148         struct ptlrpc_cli_ctx *ctx = (struct ptlrpc_cli_ctx *) data;
 149         struct key            *key = ctx2gctx_keyring(ctx)->gck_key;
 150
 151         CWARN("ctx %p, key %p\n", ctx, key);
 152
 153         LASSERT(key);
 154
 155         cli_ctx_expire(ctx);
 156         key_revoke_locked(key);
 157 }
 158
 159 static
 160 void ctx_start_timer_kr(struct ptlrpc_cli_ctx *ctx, long timeout)
 161 {
 162         struct gss_cli_ctx_keyring *gctx_kr = ctx2gctx_keyring(ctx);
 163         struct timer_list          *timer = gctx_kr->gck_timer;
 164
 165         LASSERT(timer);
 166
 167         CDEBUG(D_SEC, "ctx %p: start timer %lds\n", ctx, timeout);
 168         timeout = timeout * CFS_HZ + cfs_time_current();
 169
 170         init_timer(timer);
 171         timer->expires = timeout;
 172         timer->data = (unsigned long ) ctx;
 173         timer->function = ctx_upcall_timeout_kr;
 174
 175         add_timer(timer);
 176 }
 177
 178 /*
 179  * caller should make sure no race with other threads
 180  */
 181 static
 182 void ctx_clear_timer_kr(struct ptlrpc_cli_ctx *ctx)
 183 {
 184         struct gss_cli_ctx_keyring *gctx_kr = ctx2gctx_keyring(ctx);
 185         struct timer_list          *timer = gctx_kr->gck_timer;
 186
 187         if (timer == NULL)
 188                 return;
 189
 190         CDEBUG(D_SEC, "ctx %p, key %p\n", ctx, gctx_kr->gck_key);
 191
 192         gctx_kr->gck_timer = NULL;
 193
 194         del_singleshot_timer_sync(timer);
 195
 196         OBD_FREE_PTR(timer);
 197 }
 198
 199 static
 200 struct ptlrpc_cli_ctx *ctx_create_kr(struct ptlrpc_sec *sec,
 201                                      struct vfs_cred *vcred)
 202 {
 203         struct ptlrpc_cli_ctx      *ctx;
 204         struct gss_cli_ctx_keyring *gctx_kr;
 205
 206         OBD_ALLOC_PTR(gctx_kr);
 207         if (gctx_kr == NULL)
 208                 return NULL;
 209
 210         OBD_ALLOC_PTR(gctx_kr->gck_timer);
 211         if (gctx_kr->gck_timer == NULL) {
 212                 OBD_FREE_PTR(gctx_kr);
 213                 return NULL;
 214         }
 215         init_timer(gctx_kr->gck_timer);
 216
 217         ctx = &gctx_kr->gck_base.gc_base;
 218
 219         if (gss_cli_ctx_init_common(sec, ctx, &gss_keyring_ctxops, vcred)) {
 220                 OBD_FREE_PTR(gctx_kr->gck_timer);
 221                 OBD_FREE_PTR(gctx_kr);
 222                 return NULL;
 223         }
 224
 225         ctx->cc_expire = cfs_time_current_sec() + KEYRING_UPCALL_TIMEOUT;
 226         cfs_clear_bit(PTLRPC_CTX_NEW_BIT, &ctx->cc_flags);
 227         cfs_atomic_inc(&ctx->cc_refcount); /* for the caller */
 228
 229         return ctx;
 230 }
 231
 232 static void ctx_destroy_kr(struct ptlrpc_cli_ctx *ctx)
 233 {
 234         struct ptlrpc_sec          *sec = ctx->cc_sec;
 235         struct gss_cli_ctx_keyring *gctx_kr = ctx2gctx_keyring(ctx);
 236
 237         CDEBUG(D_SEC, "destroying ctx %p\n", ctx);
 238
 239         /* at this time the association with key has been broken. */
 240         LASSERT(sec);
 241         LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
 242         LASSERT(cfs_atomic_read(&sec->ps_nctx) > 0);
 243         LASSERT(cfs_test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags) == 0);
 244         LASSERT(gctx_kr->gck_key == NULL);
 245
 246         ctx_clear_timer_kr(ctx);
 247         LASSERT(gctx_kr->gck_timer == NULL);
 248
 249         if (gss_cli_ctx_fini_common(sec, ctx))
 250                 return;
 251
 252         OBD_FREE_PTR(gctx_kr);
 253
 254         cfs_atomic_dec(&sec->ps_nctx);
 255         sptlrpc_sec_put(sec);
 256 }
 257
 258 static void ctx_release_kr(struct ptlrpc_cli_ctx *ctx, int sync)
 259 {
 260         if (sync) {
 261                 ctx_destroy_kr(ctx);
 262         } else {
 263                 cfs_atomic_inc(&ctx->cc_refcount);
 264                 sptlrpc_gc_add_ctx(ctx);
 265         }
 266 }
 267
 268 static void ctx_put_kr(struct ptlrpc_cli_ctx *ctx, int sync)
 269 {
 270         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 271
 272         if (cfs_atomic_dec_and_test(&ctx->cc_refcount))
 273                 ctx_release_kr(ctx, sync);
 274 }
 275
 276 /*
 277  * key <-> ctx association and rules:
 278  * - ctx might not bind with any key
 279  * - key/ctx binding is protected by key semaphore (if the key present)
 280  * - key and ctx each take a reference of the other
 281  * - ctx enlist/unlist is protected by ctx spinlock
 282  * - never enlist a ctx after it's been unlisted
 283  * - whoever do enlist should also do bind, lock key before enlist:
 284  *   - lock key -> lock ctx -> enlist -> unlock ctx -> bind -> unlock key
 285  * - whoever do unlist should also do unbind:
 286  *   - lock key -> lock ctx -> unlist -> unlock ctx -> unbind -> unlock key
 287  *   - lock ctx -> unlist -> unlock ctx -> lock key -> unbind -> unlock key
 288  */
 289
 290 static inline void spin_lock_if(cfs_spinlock_t *lock, int condition)
 291 {
 292         if (condition)
 293                 cfs_spin_lock(lock);
 294 }
 295
 296 static inline void spin_unlock_if(cfs_spinlock_t *lock, int condition)
 297 {
 298         if (condition)
 299                 cfs_spin_unlock(lock);
 300 }
 301
 302 static void ctx_enlist_kr(struct ptlrpc_cli_ctx *ctx, int is_root, int locked)
 303 {
 304         struct ptlrpc_sec      *sec = ctx->cc_sec;
 305         struct gss_sec_keyring *gsec_kr = sec2gsec_keyring(sec);
 306
 307         LASSERT(!cfs_test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags));
 308         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 309
 310         spin_lock_if(&sec->ps_lock, !locked);
 311
 312         cfs_atomic_inc(&ctx->cc_refcount);
 313         cfs_set_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags);
 314         cfs_hlist_add_head(&ctx->cc_cache, &gsec_kr->gsk_clist);
 315         if (is_root)
 316                 gsec_kr->gsk_root_ctx = ctx;
 317
 318         spin_unlock_if(&sec->ps_lock, !locked);
 319 }
 320
 321 /*
 322  * Note after this get called, caller should not access ctx again because
 323  * it might have been freed, unless caller hold at least one refcount of
 324  * the ctx.
 325  *
 326  * return non-zero if we indeed unlist this ctx.
 327  */
 328 static int ctx_unlist_kr(struct ptlrpc_cli_ctx *ctx, int locked)
 329 {
 330         struct ptlrpc_sec       *sec = ctx->cc_sec;
 331         struct gss_sec_keyring  *gsec_kr = sec2gsec_keyring(sec);
 332
 333         /* if hashed bit has gone, leave the job to somebody who is doing it */
 334         if (cfs_test_and_clear_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags) == 0)
 335                 return 0;
 336
 337         /* drop ref inside spin lock to prevent race with other operations */
 338         spin_lock_if(&sec->ps_lock, !locked);
 339
 340         if (gsec_kr->gsk_root_ctx == ctx)
 341                 gsec_kr->gsk_root_ctx = NULL;
 342         cfs_hlist_del_init(&ctx->cc_cache);
 343         cfs_atomic_dec(&ctx->cc_refcount);
 344
 345         spin_unlock_if(&sec->ps_lock, !locked);
 346
 347         return 1;
 348 }
 349
 350 /*
 351  * bind a key with a ctx together.
 352  * caller must hold write lock of the key, as well as ref on key & ctx.
 353  */
 354 static void bind_key_ctx(struct key *key, struct ptlrpc_cli_ctx *ctx)
 355 {
 356         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 357         LASSERT(atomic_read(&key->usage) > 0);
 358         LASSERT(ctx2gctx_keyring(ctx)->gck_key == NULL);
 359         LASSERT(key->payload.data == NULL);
 360
 361         /* at this time context may or may not in list. */
 362         key_get(key);
 363         cfs_atomic_inc(&ctx->cc_refcount);
 364         ctx2gctx_keyring(ctx)->gck_key = key;
 365         key->payload.data = ctx;
 366 }
 367
 368 /*
 369  * unbind a key and a ctx.
 370  * caller must hold write lock, as well as a ref of the key.
 371  */
 372 static void unbind_key_ctx(struct key *key, struct ptlrpc_cli_ctx *ctx)
 373 {
 374         LASSERT(key->payload.data == ctx);
 375         LASSERT(cfs_test_bit(PTLRPC_CTX_CACHED_BIT, &ctx->cc_flags) == 0);
 376
 377         /* must revoke the key, or others may treat it as newly created */
 378         key_revoke_locked(key);
 379
 380         key->payload.data = NULL;
 381         ctx2gctx_keyring(ctx)->gck_key = NULL;
 382
 383         /* once ctx get split from key, the timer is meaningless */
 384         ctx_clear_timer_kr(ctx);
 385
 386         ctx_put_kr(ctx, 1);
 387         key_put(key);
 388 }
 389
 390 /*
 391  * given a ctx, unbind with its coupled key, if any.
 392  * unbind could only be called once, so we don't worry the key be released
 393  * by someone else.
 394  */
 395 static void unbind_ctx_kr(struct ptlrpc_cli_ctx *ctx)
 396 {
 397         struct key      *key = ctx2gctx_keyring(ctx)->gck_key;
 398
 399         if (key) {
 400                 LASSERT(key->payload.data == ctx);
 401
 402                 key_get(key);
 403                 down_write(&key->sem);
 404                 unbind_key_ctx(key, ctx);
 405                 up_write(&key->sem);
 406                 key_put(key);
 407         }
 408 }
 409
 410 /*
 411  * given a key, unbind with its coupled ctx, if any.
 412  * caller must hold write lock, as well as a ref of the key.
 413  */
 414 static void unbind_key_locked(struct key *key)
 415 {
 416         struct ptlrpc_cli_ctx   *ctx = key->payload.data;
 417
 418         if (ctx)
 419                 unbind_key_ctx(key, ctx);
 420 }
 421
 422 /*
 423  * unlist a ctx, and unbind from coupled key
 424  */
 425 static void kill_ctx_kr(struct ptlrpc_cli_ctx *ctx)
 426 {
 427         if (ctx_unlist_kr(ctx, 0))
 428                 unbind_ctx_kr(ctx);
 429 }
 430
 431 /*
 432  * given a key, unlist and unbind with the coupled ctx (if any).
 433  * caller must hold write lock, as well as a ref of the key.
 434  */
 435 static void kill_key_locked(struct key *key)
 436 {
 437         struct ptlrpc_cli_ctx *ctx = key->payload.data;
 438
 439         if (ctx && ctx_unlist_kr(ctx, 0))
 440                 unbind_key_locked(key);
 441 }
 442
 443 /*
 444  * caller should hold one ref on contexts in freelist.
 445  */
 446 static void dispose_ctx_list_kr(cfs_hlist_head_t *freelist)
 447 {
 448         cfs_hlist_node_t       *pos, *next;
 449         struct ptlrpc_cli_ctx  *ctx;
 450         struct gss_cli_ctx     *gctx;
 451
 452         cfs_hlist_for_each_entry_safe(ctx, pos, next, freelist, cc_cache) {
 453                 cfs_hlist_del_init(&ctx->cc_cache);
 454
 455                 /* reverse ctx: update current seq to buddy svcctx if exist.
 456                  * ideally this should be done at gss_cli_ctx_finalize(), but
 457                  * the ctx destroy could be delayed by:
 458                  *  1) ctx still has reference;
 459                  *  2) ctx destroy is asynchronous;
 460                  * and reverse import call inval_all_ctx() require this be done
 461                  *_immediately_ otherwise newly created reverse ctx might copy
 462                  * the very old sequence number from svcctx. */
 463                 gctx = ctx2gctx(ctx);
 464                 if (!rawobj_empty(&gctx->gc_svc_handle) &&
 465                     sec_is_reverse(gctx->gc_base.cc_sec)) {
 466                         gss_svc_upcall_update_sequence(&gctx->gc_svc_handle,
 467                                         (__u32) cfs_atomic_read(&gctx->gc_seq));
 468                 }
 469
 470                 /* we need to wakeup waiting reqs here. the context might
 471                  * be forced released before upcall finished, then the
 472                  * late-arrived downcall can't find the ctx even. */
 473                 sptlrpc_cli_ctx_wakeup(ctx);
 474
 475                 unbind_ctx_kr(ctx);
 476                 ctx_put_kr(ctx, 0);
 477         }
 478 }
 479
 480 /*
 481  * lookup a root context directly in a sec, return root ctx with a
 482  * reference taken or NULL.
 483  */
 484 static
 485 struct ptlrpc_cli_ctx * sec_lookup_root_ctx_kr(struct ptlrpc_sec *sec)
 486 {
 487         struct gss_sec_keyring  *gsec_kr = sec2gsec_keyring(sec);
 488         struct ptlrpc_cli_ctx   *ctx = NULL;
 489
 490         cfs_spin_lock(&sec->ps_lock);
 491
 492         ctx = gsec_kr->gsk_root_ctx;
 493
 494         if (ctx == NULL && unlikely(sec_is_reverse(sec))) {
 495                 cfs_hlist_node_t       *node;
 496                 struct ptlrpc_cli_ctx  *tmp;
 497
 498                 /* reverse ctx, search root ctx in list, choose the one
 499                  * with shortest expire time, which is most possibly have
 500                  * an established peer ctx at client side. */
 501                 cfs_hlist_for_each_entry(tmp, node, &gsec_kr->gsk_clist,
 502                                          cc_cache) {
 503                         if (ctx == NULL || ctx->cc_expire == 0 ||
 504                             ctx->cc_expire > tmp->cc_expire) {
 505                                 ctx = tmp;
 506                                 /* promote to be root_ctx */
 507                                 gsec_kr->gsk_root_ctx = ctx;
 508                         }
 509                 }
 510         }
 511
 512         if (ctx) {
 513                 LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 514                 LASSERT(!cfs_hlist_empty(&gsec_kr->gsk_clist));
 515                 cfs_atomic_inc(&ctx->cc_refcount);
 516         }
 517
 518         cfs_spin_unlock(&sec->ps_lock);
 519
 520         return ctx;
 521 }
 522
 523 #define RVS_CTX_EXPIRE_NICE    (10)
 524
 525 static
 526 void rvs_sec_install_root_ctx_kr(struct ptlrpc_sec *sec,
 527                                  struct ptlrpc_cli_ctx *new_ctx,
 528                                  struct key *key)
 529 {
 530         struct gss_sec_keyring *gsec_kr = sec2gsec_keyring(sec);
 531         cfs_hlist_node_t       *hnode;
 532         struct ptlrpc_cli_ctx  *ctx;
 533         cfs_time_t              now;
 534         ENTRY;
 535
 536         LASSERT(sec_is_reverse(sec));
 537
 538         cfs_spin_lock(&sec->ps_lock);
 539
 540         now = cfs_time_current_sec();
 541
 542         /* set all existing ctxs short expiry */
 543         cfs_hlist_for_each_entry(ctx, hnode, &gsec_kr->gsk_clist, cc_cache) {
 544                 if (ctx->cc_expire > now + RVS_CTX_EXPIRE_NICE) {
 545                         ctx->cc_early_expire = 1;
 546                         ctx->cc_expire = now + RVS_CTX_EXPIRE_NICE;
 547                 }
 548         }
 549
 550         /* if there's root_ctx there, instead obsolete the current
 551          * immediately, we leave it continue operating for a little while.
 552          * hopefully when the first backward rpc with newest ctx send out,
 553          * the client side already have the peer ctx well established. */
 554         ctx_enlist_kr(new_ctx, gsec_kr->gsk_root_ctx ? 0 : 1, 1);
 555
 556         if (key)
 557                 bind_key_ctx(key, new_ctx);
 558
 559         cfs_spin_unlock(&sec->ps_lock);
 560 }
 561
 562 static void construct_key_desc(void *buf, int bufsize,
 563                                struct ptlrpc_sec *sec, uid_t uid)
 564 {
 565         snprintf(buf, bufsize, "%d@%x", uid, sec->ps_id);
 566         ((char *)buf)[bufsize - 1] = '\0';
 567 }
 568
 569 /****************************************
 570  * sec apis                             *
 571  ****************************************/
 572
 573 static
 574 struct ptlrpc_sec * gss_sec_create_kr(struct obd_import *imp,
 575                                       struct ptlrpc_svc_ctx *svcctx,
 576                                       struct sptlrpc_flavor *sf)
 577 {
 578         struct gss_sec_keyring  *gsec_kr;
 579         ENTRY;
 580
 581         OBD_ALLOC(gsec_kr, sizeof(*gsec_kr));
 582         if (gsec_kr == NULL)
 583                 RETURN(NULL);
 584
 585         CFS_INIT_HLIST_HEAD(&gsec_kr->gsk_clist);
 586         gsec_kr->gsk_root_ctx = NULL;
 587         cfs_mutex_init(&gsec_kr->gsk_root_uc_lock);
 588 #ifdef HAVE_KEYRING_UPCALL_SERIALIZED
 589         cfs_mutex_init(&gsec_kr->gsk_uc_lock);
 590 #endif
 591
 592         if (gss_sec_create_common(&gsec_kr->gsk_base, &gss_policy_keyring,
 593                                   imp, svcctx, sf))
 594                 goto err_free;
 595
 596         if (svcctx != NULL &&
 597             sec_install_rctx_kr(&gsec_kr->gsk_base.gs_base, svcctx)) {
 598                 gss_sec_destroy_common(&gsec_kr->gsk_base);
 599                 goto err_free;
 600         }
 601
 602         RETURN(&gsec_kr->gsk_base.gs_base);
 603
 604 err_free:
 605         OBD_FREE(gsec_kr, sizeof(*gsec_kr));
 606         RETURN(NULL);
 607 }
 608
 609 static
 610 void gss_sec_destroy_kr(struct ptlrpc_sec *sec)
 611 {
 612         struct gss_sec          *gsec = sec2gsec(sec);
 613         struct gss_sec_keyring  *gsec_kr = sec2gsec_keyring(sec);
 614
 615         CDEBUG(D_SEC, "destroy %s@%p\n", sec->ps_policy->sp_name, sec);
 616
 617         LASSERT(cfs_hlist_empty(&gsec_kr->gsk_clist));
 618         LASSERT(gsec_kr->gsk_root_ctx == NULL);
 619
 620         gss_sec_destroy_common(gsec);
 621
 622         OBD_FREE(gsec_kr, sizeof(*gsec_kr));
 623 }
 624
 625 static inline int user_is_root(struct ptlrpc_sec *sec, struct vfs_cred *vcred)
 626 {
 627         /* except the ROOTONLY flag, treat it as root user only if real uid
 628          * is 0, euid/fsuid being 0 are handled as setuid scenarios */
 629         if (sec_is_rootonly(sec) || (vcred->vc_uid == 0))
 630                 return 1;
 631         else
 632                 return 0;
 633 }
 634
 635 /*
 636  * unlink request key from it's ring, which is linked during request_key().
 637  * sadly, we have to 'guess' which keyring it's linked to.
 638  *
 639  * FIXME this code is fragile, depend on how request_key_link() is implemented.
 640  */
 641 static void request_key_unlink(struct key *key)
 642 {
 643         struct task_struct *tsk = current;
 644         struct key *ring;
 645
 646         switch (tsk->jit_keyring) {
 647         case KEY_REQKEY_DEFL_DEFAULT:
 648         case KEY_REQKEY_DEFL_THREAD_KEYRING:
 649                 ring = key_get(tsk->thread_keyring);
 650                 if (ring)
 651                         break;
 652         case KEY_REQKEY_DEFL_PROCESS_KEYRING:
 653                 ring = key_get(tsk->signal->process_keyring);
 654                 if (ring)
 655                         break;
 656         case KEY_REQKEY_DEFL_SESSION_KEYRING:
 657                 rcu_read_lock();
 658                 ring = key_get(rcu_dereference(tsk->signal->session_keyring));
 659                 rcu_read_unlock();
 660                 if (ring)
 661                         break;
 662         case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
 663                 ring = key_get(tsk->user->session_keyring);
 664                 break;
 665         case KEY_REQKEY_DEFL_USER_KEYRING:
 666                 ring = key_get(tsk->user->uid_keyring);
 667                 break;
 668         case KEY_REQKEY_DEFL_GROUP_KEYRING:
 669         default:
 670                 LBUG();
 671         }
 672
 673         LASSERT(ring);
 674         key_unlink(ring, key);
 675         key_put(ring);
 676 }
 677
 678 static
 679 struct ptlrpc_cli_ctx * gss_sec_lookup_ctx_kr(struct ptlrpc_sec *sec,
 680                                               struct vfs_cred *vcred,
 681                                               int create, int remove_dead)
 682 {
 683         struct obd_import       *imp = sec->ps_import;
 684         struct gss_sec_keyring  *gsec_kr = sec2gsec_keyring(sec);
 685         struct ptlrpc_cli_ctx   *ctx = NULL;
 686         unsigned int             is_root = 0, create_new = 0;
 687         struct key              *key;
 688         char                     desc[24];
 689         char                    *coinfo;
 690         int                      coinfo_size;
 691         char                    *co_flags = "";
 692         ENTRY;
 693
 694         LASSERT(imp != NULL);
 695
 696         is_root = user_is_root(sec, vcred);
 697
 698         /* a little bit optimization for root context */
 699         if (is_root) {
 700                 ctx = sec_lookup_root_ctx_kr(sec);
 701                 /*
 702                  * Only lookup directly for REVERSE sec, which should
 703                  * always succeed.
 704                  */
 705                 if (ctx || sec_is_reverse(sec))
 706                         RETURN(ctx);
 707         }
 708
 709         LASSERT(create != 0);
 710
 711         /* for root context, obtain lock and check again, this time hold
 712          * the root upcall lock, make sure nobody else populated new root
 713          * context after last check. */
 714         if (is_root) {
 715                 cfs_mutex_lock(&gsec_kr->gsk_root_uc_lock);
 716
 717                 ctx = sec_lookup_root_ctx_kr(sec);
 718                 if (ctx)
 719                         goto out;
 720
 721                 /* update reverse handle for root user */
 722                 sec2gsec(sec)->gs_rvs_hdl = gss_get_next_ctx_index();
 723
 724                 switch (sec->ps_part) {
 725                 case LUSTRE_SP_MDT:
 726                         co_flags = "m";
 727                         break;
 728                 case LUSTRE_SP_OST:
 729                         co_flags = "o";
 730                         break;
 731                 case LUSTRE_SP_MGC:
 732                         co_flags = "rmo";
 733                         break;
 734                 case LUSTRE_SP_CLI:
 735                         co_flags = "r";
 736                         break;
 737                 case LUSTRE_SP_MGS:
 738                 default:
 739                         LBUG();
 740                 }
 741         }
 742
 743         /* in case of setuid, key will be constructed as owner of fsuid/fsgid,
 744          * but we do authentication based on real uid/gid. the key permission
 745          * bits will be exactly as POS_ALL, so only processes who subscribed
 746          * this key could have the access, although the quota might be counted
 747          * on others (fsuid/fsgid).
 748          *
 749          * keyring will use fsuid/fsgid as upcall parameters, so we have to
 750          * encode real uid/gid into callout info.
 751          */
 752
 753         construct_key_desc(desc, sizeof(desc), sec, vcred->vc_uid);
 754
 755         /* callout info format:
 756          * secid:mech:uid:gid:flags:svc_type:peer_nid:target_uuid
 757          */
 758         coinfo_size = sizeof(struct obd_uuid) + MAX_OBD_NAME + 64;
 759         OBD_ALLOC(coinfo, coinfo_size);
 760         if (coinfo == NULL)
 761                 goto out;
 762
 763         snprintf(coinfo, coinfo_size, "%d:%s:%u:%u:%s:%d:"LPX64":%s",
 764                  sec->ps_id, sec2gsec(sec)->gs_mech->gm_name,
 765                  vcred->vc_uid, vcred->vc_gid,
 766                  co_flags, import_to_gss_svc(imp),
 767                  imp->imp_connection->c_peer.nid, imp->imp_obd->obd_name);
 768
 769         CDEBUG(D_SEC, "requesting key for %s\n", desc);
 770
 771         keyring_upcall_lock(gsec_kr);
 772         key = request_key(&gss_key_type, desc, coinfo);
 773         keyring_upcall_unlock(gsec_kr);
 774
 775         OBD_FREE(coinfo, coinfo_size);
 776
 777         if (IS_ERR(key)) {
 778                 CERROR("failed request key: %ld\n", PTR_ERR(key));
 779                 goto out;
 780         }
 781         CDEBUG(D_SEC, "obtained key %08x for %s\n", key->serial, desc);
 782
 783         /* once payload.data was pointed to a ctx, it never changes until
 784          * we de-associate them; but parallel request_key() may return
 785          * a key with payload.data == NULL at the same time. so we still
 786          * need wirtelock of key->sem to serialize them. */
 787         down_write(&key->sem);
 788
 789         if (likely(key->payload.data != NULL)) {
 790                 ctx = key->payload.data;
 791
 792                 LASSERT(cfs_atomic_read(&ctx->cc_refcount) >= 1);
 793                 LASSERT(ctx2gctx_keyring(ctx)->gck_key == key);
 794                 LASSERT(atomic_read(&key->usage) >= 2);
 795
 796                 /* simply take a ref and return. it's upper layer's
 797                  * responsibility to detect & replace dead ctx. */
 798                 cfs_atomic_inc(&ctx->cc_refcount);
 799         } else {
 800                 /* pre initialization with a cli_ctx. this can't be done in
 801                  * key_instantiate() because we'v no enough information
 802                  * there. */
 803                 ctx = ctx_create_kr(sec, vcred);
 804                 if (ctx != NULL) {
 805                         ctx_enlist_kr(ctx, is_root, 0);
 806                         bind_key_ctx(key, ctx);
 807
 808                         ctx_start_timer_kr(ctx, KEYRING_UPCALL_TIMEOUT);
 809
 810                         CDEBUG(D_SEC, "installed key %p <-> ctx %p (sec %p)\n",
 811                                key, ctx, sec);
 812                 } else {
 813                         /* we'd prefer to call key_revoke(), but we more like
 814                          * to revoke it within this key->sem locked period. */
 815                         key_revoke_locked(key);
 816                 }
 817
 818                 create_new = 1;
 819         }
 820
 821         up_write(&key->sem);
 822
 823         if (is_root && create_new)
 824                 request_key_unlink(key);
 825
 826         key_put(key);
 827 out:
 828         if (is_root)
 829                 cfs_mutex_unlock(&gsec_kr->gsk_root_uc_lock);
 830         RETURN(ctx);
 831 }
 832
 833 static
 834 void gss_sec_release_ctx_kr(struct ptlrpc_sec *sec,
 835                             struct ptlrpc_cli_ctx *ctx,
 836                             int sync)
 837 {
 838         LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
 839         LASSERT(cfs_atomic_read(&ctx->cc_refcount) == 0);
 840         ctx_release_kr(ctx, sync);
 841 }
 842
 843 /*
 844  * flush context of normal user, we must resort to keyring itself to find out
 845  * contexts which belong to me.
 846  *
 847  * Note here we suppose only to flush _my_ context, the "uid" will
 848  * be ignored in the search.
 849  */
 850 static
 851 void flush_user_ctx_cache_kr(struct ptlrpc_sec *sec,
 852                              uid_t uid,
 853                              int grace, int force)
 854 {
 855         struct key              *key;
 856         char                     desc[24];
 857
 858         /* nothing to do for reverse or rootonly sec */
 859         if (sec_is_reverse(sec) || sec_is_rootonly(sec))
 860                 return;
 861
 862         construct_key_desc(desc, sizeof(desc), sec, uid);
 863
 864         /* there should be only one valid key, but we put it in the
 865          * loop in case of any weird cases */
 866         for (;;) {
 867                 key = request_key(&gss_key_type, desc, NULL);
 868                 if (IS_ERR(key)) {
 869                         CDEBUG(D_SEC, "No more key found for current user\n");
 870                         break;
 871                 }
 872
 873                 down_write(&key->sem);
 874
 875                 kill_key_locked(key);
 876
 877                 /* kill_key_locked() should usually revoke the key, but we
 878                  * revoke it again to make sure, e.g. some case the key may
 879                  * not well coupled with a context. */
 880                 key_revoke_locked(key);
 881
 882                 up_write(&key->sem);
 883
 884                 key_put(key);
 885         }
 886 }
 887
 888 /*
 889  * flush context of root or all, we iterate through the list.
 890  */
 891 static
 892 void flush_spec_ctx_cache_kr(struct ptlrpc_sec *sec,
 893                              uid_t uid,
 894                              int grace, int force)
 895 {
 896         struct gss_sec_keyring *gsec_kr;
 897         cfs_hlist_head_t        freelist = CFS_HLIST_HEAD_INIT;
 898         cfs_hlist_node_t       *pos, *next;
 899         struct ptlrpc_cli_ctx  *ctx;
 900         ENTRY;
 901
 902         gsec_kr = sec2gsec_keyring(sec);
 903
 904         cfs_spin_lock(&sec->ps_lock);
 905         cfs_hlist_for_each_entry_safe(ctx, pos, next,
 906                                       &gsec_kr->gsk_clist, cc_cache) {
 907                 LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 908
 909                 if (uid != -1 && uid != ctx->cc_vcred.vc_uid)
 910                         continue;
 911
 912                 /* at this moment there's at least 2 base reference:
 913                  * key association and in-list. */
 914                 if (cfs_atomic_read(&ctx->cc_refcount) > 2) {
 915                         if (!force)
 916                                 continue;
 917                         CWARN("flush busy ctx %p(%u->%s, extra ref %d)\n",
 918                               ctx, ctx->cc_vcred.vc_uid,
 919                               sec2target_str(ctx->cc_sec),
 920                               cfs_atomic_read(&ctx->cc_refcount) - 2);
 921                 }
 922
 923                 cfs_set_bit(PTLRPC_CTX_DEAD_BIT, &ctx->cc_flags);
 924                 if (!grace)
 925                         cfs_clear_bit(PTLRPC_CTX_UPTODATE_BIT, &ctx->cc_flags);
 926
 927                 cfs_atomic_inc(&ctx->cc_refcount);
 928
 929                 if (ctx_unlist_kr(ctx, 1)) {
 930                         cfs_hlist_add_head(&ctx->cc_cache, &freelist);
 931                 } else {
 932                         LASSERT(cfs_atomic_read(&ctx->cc_refcount) >= 2);
 933                         cfs_atomic_dec(&ctx->cc_refcount);
 934                 }
 935         }
 936         cfs_spin_unlock(&sec->ps_lock);
 937
 938         dispose_ctx_list_kr(&freelist);
 939         EXIT;
 940 }
 941
 942 static
 943 int gss_sec_flush_ctx_cache_kr(struct ptlrpc_sec *sec,
 944                                uid_t uid, int grace, int force)
 945 {
 946         ENTRY;
 947
 948         CDEBUG(D_SEC, "sec %p(%d, nctx %d), uid %d, grace %d, force %d\n",
 949                sec, cfs_atomic_read(&sec->ps_refcount),
 950                cfs_atomic_read(&sec->ps_nctx),
 951                uid, grace, force);
 952
 953         if (uid != -1 && uid != 0)
 954                 flush_user_ctx_cache_kr(sec, uid, grace, force);
 955         else
 956                 flush_spec_ctx_cache_kr(sec, uid, grace, force);
 957
 958         RETURN(0);
 959 }
 960
 961 static
 962 void gss_sec_gc_ctx_kr(struct ptlrpc_sec *sec)
 963 {
 964         struct gss_sec_keyring *gsec_kr = sec2gsec_keyring(sec);
 965         cfs_hlist_head_t        freelist = CFS_HLIST_HEAD_INIT;
 966         cfs_hlist_node_t       *pos, *next;
 967         struct ptlrpc_cli_ctx  *ctx;
 968         ENTRY;
 969
 970         CWARN("running gc\n");
 971
 972         cfs_spin_lock(&sec->ps_lock);
 973         cfs_hlist_for_each_entry_safe(ctx, pos, next,
 974                                       &gsec_kr->gsk_clist, cc_cache) {
 975                 LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
 976
 977                 cfs_atomic_inc(&ctx->cc_refcount);
 978
 979                 if (cli_ctx_check_death(ctx) && ctx_unlist_kr(ctx, 1)) {
 980                         cfs_hlist_add_head(&ctx->cc_cache, &freelist);
 981                         CWARN("unhashed ctx %p\n", ctx);
 982                 } else {
 983                         LASSERT(cfs_atomic_read(&ctx->cc_refcount) >= 2);
 984                         cfs_atomic_dec(&ctx->cc_refcount);
 985                 }
 986         }
 987         cfs_spin_unlock(&sec->ps_lock);
 988
 989         dispose_ctx_list_kr(&freelist);
 990         EXIT;
 991         return;
 992 }
 993
 994 static
 995 int gss_sec_display_kr(struct ptlrpc_sec *sec, struct seq_file *seq)
 996 {
 997         struct gss_sec_keyring *gsec_kr = sec2gsec_keyring(sec);
 998         cfs_hlist_node_t       *pos, *next;
 999         struct ptlrpc_cli_ctx  *ctx;
1000         struct gss_cli_ctx     *gctx;
1001         time_t                  now = cfs_time_current_sec();
1002         ENTRY;
1003
1004         cfs_spin_lock(&sec->ps_lock);
1005         cfs_hlist_for_each_entry_safe(ctx, pos, next,
1006                                   &gsec_kr->gsk_clist, cc_cache) {
1007                 struct key             *key;
1008                 char                    flags_str[40];
1009                 char                    mech[40];
1010
1011                 gctx = ctx2gctx(ctx);
1012                 key = ctx2gctx_keyring(ctx)->gck_key;
1013
1014                 gss_cli_ctx_flags2str(ctx->cc_flags,
1015                                       flags_str, sizeof(flags_str));
1016
1017                 if (gctx->gc_mechctx)
1018                         lgss_display(gctx->gc_mechctx, mech, sizeof(mech));
1019                 else
1020                         snprintf(mech, sizeof(mech), "N/A");
1021                 mech[sizeof(mech) - 1] = '\0';
1022
1023                 seq_printf(seq, "%p: uid %u, ref %d, expire %ld(%+ld), fl %s, "
1024                            "seq %d, win %u, key %08x(ref %d), "
1025                            "hdl "LPX64":"LPX64", mech: %s\n",
1026                            ctx, ctx->cc_vcred.vc_uid,
1027                            cfs_atomic_read(&ctx->cc_refcount),
1028                            ctx->cc_expire,
1029                            ctx->cc_expire ?  ctx->cc_expire - now : 0,
1030                            flags_str,
1031                            cfs_atomic_read(&gctx->gc_seq),
1032                            gctx->gc_win,
1033                            key ? key->serial : 0,
1034                            key ? atomic_read(&key->usage) : 0,
1035                            gss_handle_to_u64(&gctx->gc_handle),
1036                            gss_handle_to_u64(&gctx->gc_svc_handle),
1037                            mech);
1038         }
1039         cfs_spin_unlock(&sec->ps_lock);
1040
1041         RETURN(0);
1042 }
1043
1044 /****************************************
1045  * cli_ctx apis                         *
1046  ****************************************/
1047
1048 static
1049 int gss_cli_ctx_refresh_kr(struct ptlrpc_cli_ctx *ctx)
1050 {
1051         /* upcall is already on the way */
1052         return 0;
1053 }
1054
1055 static
1056 int gss_cli_ctx_validate_kr(struct ptlrpc_cli_ctx *ctx)
1057 {
1058         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
1059         LASSERT(ctx->cc_sec);
1060
1061         if (cli_ctx_check_death(ctx)) {
1062                 kill_ctx_kr(ctx);
1063                 return 1;
1064         }
1065
1066         if (cli_ctx_is_ready(ctx))
1067                 return 0;
1068         return 1;
1069 }
1070
1071 static
1072 void gss_cli_ctx_die_kr(struct ptlrpc_cli_ctx *ctx, int grace)
1073 {
1074         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
1075         LASSERT(ctx->cc_sec);
1076
1077         cli_ctx_expire(ctx);
1078         kill_ctx_kr(ctx);
1079 }
1080
1081 /****************************************
1082  * (reverse) service                    *
1083  ****************************************/
1084
1085 /*
1086  * reverse context could have nothing to do with keyrings. here we still keep
1087  * the version which bind to a key, for future reference.
1088  */
1089 #define HAVE_REVERSE_CTX_NOKEY
1090
1091 #ifdef HAVE_REVERSE_CTX_NOKEY
1092
1093 static
1094 int sec_install_rctx_kr(struct ptlrpc_sec *sec,
1095                         struct ptlrpc_svc_ctx *svc_ctx)
1096 {
1097         struct ptlrpc_cli_ctx   *cli_ctx;
1098         struct vfs_cred          vcred = { 0, 0 };
1099         int                      rc;
1100
1101         LASSERT(sec);
1102         LASSERT(svc_ctx);
1103
1104         cli_ctx = ctx_create_kr(sec, &vcred);
1105         if (cli_ctx == NULL)
1106                 return -ENOMEM;
1107
1108         rc = gss_copy_rvc_cli_ctx(cli_ctx, svc_ctx);
1109         if (rc) {
1110                 CERROR("failed copy reverse cli ctx: %d\n", rc);
1111
1112                 ctx_put_kr(cli_ctx, 1);
1113                 return rc;
1114         }
1115
1116         rvs_sec_install_root_ctx_kr(sec, cli_ctx, NULL);
1117
1118         ctx_put_kr(cli_ctx, 1);
1119
1120         return 0;
1121 }
1122
1123 #else /* ! HAVE_REVERSE_CTX_NOKEY */
1124
1125 static
1126 int sec_install_rctx_kr(struct ptlrpc_sec *sec,
1127                         struct ptlrpc_svc_ctx *svc_ctx)
1128 {
1129         struct ptlrpc_cli_ctx   *cli_ctx = NULL;
1130         struct key              *key;
1131         struct vfs_cred          vcred = { 0, 0 };
1132         char                     desc[64];
1133         int                      rc;
1134
1135         LASSERT(sec);
1136         LASSERT(svc_ctx);
1137         CWARN("called\n");
1138
1139         construct_key_desc(desc, sizeof(desc), sec, 0);
1140
1141         key = key_alloc(&gss_key_type, desc, 0, 0,
1142                         KEY_POS_ALL | KEY_USR_ALL, 1);
1143         if (IS_ERR(key)) {
1144                 CERROR("failed to alloc key: %ld\n", PTR_ERR(key));
1145                 return PTR_ERR(key);
1146         }
1147
1148         rc = key_instantiate_and_link(key, NULL, 0, NULL, NULL);
1149         if (rc) {
1150                 CERROR("failed to instantiate key: %d\n", rc);
1151                 goto err_revoke;
1152         }
1153
1154         down_write(&key->sem);
1155
1156         LASSERT(key->payload.data == NULL);
1157
1158         cli_ctx = ctx_create_kr(sec, &vcred);
1159         if (cli_ctx == NULL) {
1160                 rc = -ENOMEM;
1161                 goto err_up;
1162         }
1163
1164         rc = gss_copy_rvc_cli_ctx(cli_ctx, svc_ctx);
1165         if (rc) {
1166                 CERROR("failed copy reverse cli ctx: %d\n", rc);
1167                 goto err_put;
1168         }
1169
1170         rvs_sec_install_root_ctx_kr(sec, cli_ctx, key);
1171
1172         ctx_put_kr(cli_ctx, 1);
1173         up_write(&key->sem);
1174
1175         rc = 0;
1176         CWARN("ok!\n");
1177 out:
1178         key_put(key);
1179         return rc;
1180
1181 err_put:
1182         ctx_put_kr(cli_ctx, 1);
1183 err_up:
1184         up_write(&key->sem);
1185 err_revoke:
1186         key_revoke(key);
1187         goto out;
1188 }
1189
1190 #endif /* HAVE_REVERSE_CTX_NOKEY */
1191
1192 /****************************************
1193  * service apis                         *
1194  ****************************************/
1195
1196 static
1197 int gss_svc_accept_kr(struct ptlrpc_request *req)
1198 {
1199         return gss_svc_accept(&gss_policy_keyring, req);
1200 }
1201
1202 static
1203 int gss_svc_install_rctx_kr(struct obd_import *imp,
1204                             struct ptlrpc_svc_ctx *svc_ctx)
1205 {
1206         struct ptlrpc_sec *sec;
1207         int                rc;
1208
1209         sec = sptlrpc_import_sec_ref(imp);
1210         LASSERT(sec);
1211
1212         rc = sec_install_rctx_kr(sec, svc_ctx);
1213         sptlrpc_sec_put(sec);
1214
1215         return rc;
1216 }
1217
1218 /****************************************
1219  * key apis                             *
1220  ****************************************/
1221
1222 static
1223 int gss_kt_instantiate(struct key *key, const void *data, size_t datalen)
1224 {
1225         int             rc;
1226         ENTRY;
1227
1228         if (data != NULL || datalen != 0) {
1229                 CERROR("invalid: data %p, len %lu\n", data, (long)datalen);
1230                 RETURN(-EINVAL);
1231         }
1232
1233         if (key->payload.data != 0) {
1234                 CERROR("key already have payload\n");
1235                 RETURN(-EINVAL);
1236         }
1237
1238         /* link the key to session keyring, so following context negotiation
1239          * rpc fired from user space could find this key. This will be unlinked
1240          * automatically when upcall processes die.
1241          *
1242          * we can't do this through keyctl from userspace, because the upcall
1243          * might be neither possessor nor owner of the key (setuid).
1244          *
1245          * the session keyring is created upon upcall, and don't change all
1246          * the way until upcall finished, so rcu lock is not needed here.
1247          */
1248         LASSERT(cfs_current()->signal->session_keyring);
1249
1250         cfs_lockdep_off();
1251         rc = key_link(cfs_current()->signal->session_keyring, key);
1252         cfs_lockdep_on();
1253         if (unlikely(rc)) {
1254                 CERROR("failed to link key %08x to keyring %08x: %d\n",
1255                        key->serial,
1256                        cfs_current()->signal->session_keyring->serial, rc);
1257                 RETURN(rc);
1258         }
1259
1260         CDEBUG(D_SEC, "key %p instantiated, ctx %p\n", key, key->payload.data);
1261         RETURN(0);
1262 }
1263
1264 /*
1265  * called with key semaphore write locked. it means we can operate
1266  * on the context without fear of loosing refcount.
1267  */
1268 static
1269 int gss_kt_update(struct key *key, const void *data, size_t datalen)
1270 {
1271         struct ptlrpc_cli_ctx   *ctx = key->payload.data;
1272         struct gss_cli_ctx      *gctx;
1273         rawobj_t                 tmpobj = RAWOBJ_EMPTY;
1274         __u32                    datalen32 = (__u32) datalen;
1275         int                      rc;
1276         ENTRY;
1277
1278         if (data == NULL || datalen == 0) {
1279                 CWARN("invalid: data %p, len %lu\n", data, (long)datalen);
1280                 RETURN(-EINVAL);
1281         }
1282
1283         /* if upcall finished negotiation too fast (mostly likely because
1284          * of local error happened) and call kt_update(), the ctx
1285          * might be still NULL. but the key will finally be associate
1286          * with a context, or be revoked. if key status is fine, return
1287          * -EAGAIN to allow userspace sleep a while and call again. */
1288         if (ctx == NULL) {
1289                 CDEBUG(D_SEC, "update too soon: key %p(%x) flags %lx\n",
1290                       key, key->serial, key->flags);
1291
1292                 rc = key_validate(key);
1293                 if (rc == 0)
1294                         RETURN(-EAGAIN);
1295                 else
1296                         RETURN(rc);
1297         }
1298
1299         LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
1300         LASSERT(ctx->cc_sec);
1301
1302         ctx_clear_timer_kr(ctx);
1303
1304         /* don't proceed if already refreshed */
1305         if (cli_ctx_is_refreshed(ctx)) {
1306                 CWARN("ctx already done refresh\n");
1307                 RETURN(0);
1308         }
1309
1310         sptlrpc_cli_ctx_get(ctx);
1311         gctx = ctx2gctx(ctx);
1312
1313         rc = buffer_extract_bytes(&data, &datalen32, &gctx->gc_win,
1314                                   sizeof(gctx->gc_win));
1315         if (rc) {
1316                 CERROR("failed extract seq_win\n");
1317                 goto out;
1318         }
1319
1320         if (gctx->gc_win == 0) {
1321                 __u32   nego_rpc_err, nego_gss_err;
1322
1323                 rc = buffer_extract_bytes(&data, &datalen32, &nego_rpc_err,
1324                                           sizeof(nego_rpc_err));
1325                 if (rc) {
1326                         CERROR("failed to extrace rpc rc\n");
1327                         goto out;
1328                 }
1329
1330                 rc = buffer_extract_bytes(&data, &datalen32, &nego_gss_err,
1331                                           sizeof(nego_gss_err));
1332                 if (rc) {
1333                         CERROR("failed to extrace gss rc\n");
1334                         goto out;
1335                 }
1336
1337                 CERROR("negotiation: rpc err %d, gss err %x\n",
1338                        nego_rpc_err, nego_gss_err);
1339
1340                 rc = nego_rpc_err ? nego_rpc_err : -EACCES;
1341         } else {
1342                 rc = rawobj_extract_local_alloc(&gctx->gc_handle,
1343                                                 (__u32 **) &data, &datalen32);
1344                 if (rc) {
1345                         CERROR("failed extract handle\n");
1346                         goto out;
1347                 }
1348
1349                 rc = rawobj_extract_local(&tmpobj, (__u32 **) &data,&datalen32);
1350                 if (rc) {
1351                         CERROR("failed extract mech\n");
1352                         goto out;
1353                 }
1354
1355                 rc = lgss_import_sec_context(&tmpobj,
1356                                              sec2gsec(ctx->cc_sec)->gs_mech,
1357                                              &gctx->gc_mechctx);
1358                 if (rc != GSS_S_COMPLETE)
1359                         CERROR("failed import context\n");
1360                 else
1361                         rc = 0;
1362         }
1363 out:
1364         /* we don't care what current status of this ctx, even someone else
1365          * is operating on the ctx at the same time. we just add up our own
1366          * opinions here. */
1367         if (rc == 0) {
1368                 gss_cli_ctx_uptodate(gctx);
1369         } else {
1370                 /* this will also revoke the key. has to be done before
1371                  * wakeup waiters otherwise they can find the stale key */
1372                 kill_key_locked(key);
1373
1374                 cli_ctx_expire(ctx);
1375
1376                 if (rc != -ERESTART)
1377                         cfs_set_bit(PTLRPC_CTX_ERROR_BIT, &ctx->cc_flags);
1378         }
1379
1380         /* let user space think it's a success */
1381         sptlrpc_cli_ctx_put(ctx, 1);
1382         RETURN(0);
1383 }
1384
1385 static
1386 int gss_kt_match(const struct key *key, const void *desc)
1387 {
1388         return (strcmp(key->description, (const char *) desc) == 0);
1389 }
1390
1391 static
1392 void gss_kt_destroy(struct key *key)
1393 {
1394         ENTRY;
1395         LASSERT(key->payload.data == NULL);
1396         CDEBUG(D_SEC, "destroy key %p\n", key);
1397         EXIT;
1398 }
1399
1400 static
1401 void gss_kt_describe(const struct key *key, struct seq_file *s)
1402 {
1403         if (key->description == NULL)
1404                 seq_puts(s, "[null]");
1405         else
1406                 seq_puts(s, key->description);
1407 }
1408
1409 static struct key_type gss_key_type =
1410 {
1411         .name           = "lgssc",
1412         .def_datalen    = 0,
1413         .instantiate    = gss_kt_instantiate,
1414         .update         = gss_kt_update,
1415         .match          = gss_kt_match,
1416         .destroy        = gss_kt_destroy,
1417         .describe       = gss_kt_describe,
1418 };
1419
1420 /****************************************
1421  * lustre gss keyring policy            *
1422  ****************************************/
1423
1424 static struct ptlrpc_ctx_ops gss_keyring_ctxops = {
1425         .match                  = gss_cli_ctx_match,
1426         .refresh                = gss_cli_ctx_refresh_kr,
1427         .validate               = gss_cli_ctx_validate_kr,
1428         .die                    = gss_cli_ctx_die_kr,
1429         .sign                   = gss_cli_ctx_sign,
1430         .verify                 = gss_cli_ctx_verify,
1431         .seal                   = gss_cli_ctx_seal,
1432         .unseal                 = gss_cli_ctx_unseal,
1433         .wrap_bulk              = gss_cli_ctx_wrap_bulk,
1434         .unwrap_bulk            = gss_cli_ctx_unwrap_bulk,
1435 };
1436
1437 static struct ptlrpc_sec_cops gss_sec_keyring_cops = {
1438         .create_sec             = gss_sec_create_kr,
1439         .destroy_sec            = gss_sec_destroy_kr,
1440         .kill_sec               = gss_sec_kill,
1441         .lookup_ctx             = gss_sec_lookup_ctx_kr,
1442         .release_ctx            = gss_sec_release_ctx_kr,
1443         .flush_ctx_cache        = gss_sec_flush_ctx_cache_kr,
1444         .gc_ctx                 = gss_sec_gc_ctx_kr,
1445         .install_rctx           = gss_sec_install_rctx,
1446         .alloc_reqbuf           = gss_alloc_reqbuf,
1447         .free_reqbuf            = gss_free_reqbuf,
1448         .alloc_repbuf           = gss_alloc_repbuf,
1449         .free_repbuf            = gss_free_repbuf,
1450         .enlarge_reqbuf         = gss_enlarge_reqbuf,
1451         .display                = gss_sec_display_kr,
1452 };
1453
1454 static struct ptlrpc_sec_sops gss_sec_keyring_sops = {
1455         .accept                 = gss_svc_accept_kr,
1456         .invalidate_ctx         = gss_svc_invalidate_ctx,
1457         .alloc_rs               = gss_svc_alloc_rs,
1458         .authorize              = gss_svc_authorize,
1459         .free_rs                = gss_svc_free_rs,
1460         .free_ctx               = gss_svc_free_ctx,
1461         .prep_bulk              = gss_svc_prep_bulk,
1462         .unwrap_bulk            = gss_svc_unwrap_bulk,
1463         .wrap_bulk              = gss_svc_wrap_bulk,
1464         .install_rctx           = gss_svc_install_rctx_kr,
1465 };
1466
1467 static struct ptlrpc_sec_policy gss_policy_keyring = {
1468         .sp_owner               = THIS_MODULE,
1469         .sp_name                = "gss.keyring",
1470         .sp_policy              = SPTLRPC_POLICY_GSS,
1471         .sp_cops                = &gss_sec_keyring_cops,
1472         .sp_sops                = &gss_sec_keyring_sops,
1473 };
1474
1475
1476 int __init gss_init_keyring(void)
1477 {
1478         int rc;
1479
1480         rc = register_key_type(&gss_key_type);
1481         if (rc) {
1482                 CERROR("failed to register keyring type: %d\n", rc);
1483                 return rc;
1484         }
1485
1486         rc = sptlrpc_register_policy(&gss_policy_keyring);
1487         if (rc) {
1488                 unregister_key_type(&gss_key_type);
1489                 return rc;
1490         }
1491
1492         return 0;
1493 }
1494
1495 void __exit gss_exit_keyring(void)
1496 {
1497         unregister_key_type(&gss_key_type);
1498         sptlrpc_unregister_policy(&gss_policy_keyring);
1499 }