lustre/ptlrpc/gss/gss_keyring.c

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