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