lustre/ptlrpc/sec_null.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) 2011, 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/sec_null.c
  37  *
  38  * Author: Eric Mei <ericm@clusterfs.com>
  39  */
  40
  41 #define DEBUG_SUBSYSTEM S_SEC
  42
  43
  44 #include <obd_support.h>
  45 #include <obd_cksum.h>
  46 #include <obd_class.h>
  47 #include <lustre_net.h>
  48 #include <lustre_sec.h>
  49
  50 #include "ptlrpc_internal.h"
  51
  52 static struct ptlrpc_sec_policy null_policy;
  53 static struct ptlrpc_sec        null_sec;
  54 static struct ptlrpc_cli_ctx    null_cli_ctx;
  55 static struct ptlrpc_svc_ctx    null_svc_ctx;
  56
  57 /*
  58  * we can temporarily use the topmost 8-bits of lm_secflvr to identify
  59  * the source sec part.
  60  */
  61 static inline
  62 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
  63 {
  64         msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
  65 }
  66
  67 static inline
  68 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
  69 {
  70         return (msg->lm_secflvr >> 24) & 0xFF;
  71 }
  72
  73 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
  74 {
  75         /* should never reach here */
  76         LBUG();
  77         return 0;
  78 }
  79
  80 static
  81 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
  82 {
  83         req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
  84
  85         if (!req->rq_import->imp_dlm_fake) {
  86                 struct obd_device *obd = req->rq_import->imp_obd;
  87                 null_encode_sec_part(req->rq_reqbuf,
  88                                      obd->u.cli.cl_sp_me);
  89         }
  90         req->rq_reqdata_len = req->rq_reqlen;
  91         return 0;
  92 }
  93
  94 static
  95 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
  96 {
  97         __u32   cksums, cksumc;
  98
  99         LASSERT(req->rq_repdata);
 100
 101         req->rq_repmsg = req->rq_repdata;
 102         req->rq_replen = req->rq_repdata_len;
 103
 104         if (req->rq_early) {
 105                 cksums = lustre_msg_get_cksum(req->rq_repdata);
 106                 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
 107
 108                 if (cksumc != cksums) {
 109                         CDEBUG(D_SEC,
 110                                "early reply checksum mismatch: %08x != %08x\n",
 111                                cksumc, cksums);
 112                         return -EINVAL;
 113                 }
 114         }
 115
 116         return 0;
 117 }
 118
 119 static
 120 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
 121                                    struct ptlrpc_svc_ctx *svc_ctx,
 122                                    struct sptlrpc_flavor *sf)
 123 {
 124         LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
 125
 126         /* general layer has take a module reference for us, because we never
 127          * really destroy the sec, simply release the reference here.
 128          */
 129         sptlrpc_policy_put(&null_policy);
 130         return &null_sec;
 131 }
 132
 133 static
 134 void null_destroy_sec(struct ptlrpc_sec *sec)
 135 {
 136         LASSERT(sec == &null_sec);
 137 }
 138
 139 static
 140 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
 141                                        struct vfs_cred *vcred,
 142                                        int create, int remove_dead)
 143 {
 144         atomic_inc(&null_cli_ctx.cc_refcount);
 145         return &null_cli_ctx;
 146 }
 147
 148 static
 149 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
 150                          uid_t uid,
 151                          int grace, int force)
 152 {
 153         return 0;
 154 }
 155
 156 static
 157 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
 158                       struct ptlrpc_request *req,
 159                       int msgsize)
 160 {
 161         if (!req->rq_reqbuf) {
 162                 int alloc_size = size_roundup_power2(msgsize);
 163
 164                 LASSERT(!req->rq_pool);
 165                 OBD_ALLOC_LARGE(req->rq_reqbuf, alloc_size);
 166                 if (!req->rq_reqbuf)
 167                         return -ENOMEM;
 168
 169                 req->rq_reqbuf_len = alloc_size;
 170         } else {
 171                 LASSERT(req->rq_pool);
 172                 LASSERT(req->rq_reqbuf_len >= msgsize);
 173                 memset(req->rq_reqbuf, 0, msgsize);
 174         }
 175
 176         req->rq_reqmsg = req->rq_reqbuf;
 177         return 0;
 178 }
 179
 180 static
 181 void null_free_reqbuf(struct ptlrpc_sec *sec,
 182                       struct ptlrpc_request *req)
 183 {
 184         if (!req->rq_pool) {
 185                 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
 186                          "req %p: reqmsg %p is not reqbuf %p in null sec\n",
 187                          req, req->rq_reqmsg, req->rq_reqbuf);
 188                 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
 189                          "req %p: reqlen %d should smaller than buflen %d\n",
 190                          req, req->rq_reqlen, req->rq_reqbuf_len);
 191
 192                 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
 193                 req->rq_reqbuf = NULL;
 194                 req->rq_reqbuf_len = 0;
 195         }
 196 }
 197
 198 static
 199 int null_alloc_repbuf(struct ptlrpc_sec *sec,
 200                       struct ptlrpc_request *req,
 201                       int msgsize)
 202 {
 203         /* add space for early replied */
 204         msgsize += lustre_msg_early_size();
 205
 206         msgsize = size_roundup_power2(msgsize);
 207
 208         OBD_ALLOC_LARGE(req->rq_repbuf, msgsize);
 209         if (!req->rq_repbuf)
 210                 return -ENOMEM;
 211
 212         req->rq_repbuf_len = msgsize;
 213         return 0;
 214 }
 215
 216 static
 217 void null_free_repbuf(struct ptlrpc_sec *sec,
 218                       struct ptlrpc_request *req)
 219 {
 220         LASSERT(req->rq_repbuf);
 221
 222         OBD_FREE_LARGE(req->rq_repbuf, req->rq_repbuf_len);
 223         req->rq_repbuf = NULL;
 224         req->rq_repbuf_len = 0;
 225 }
 226
 227 static
 228 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
 229                         struct ptlrpc_request *req,
 230                         int segment, int newsize)
 231 {
 232         struct lustre_msg      *newbuf;
 233         struct lustre_msg      *oldbuf = req->rq_reqmsg;
 234         int                     oldsize, newmsg_size, alloc_size;
 235
 236         LASSERT(req->rq_reqbuf);
 237         LASSERT(req->rq_reqbuf == req->rq_reqmsg);
 238         LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
 239         LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
 240
 241         /* compute new message size */
 242         oldsize = req->rq_reqbuf->lm_buflens[segment];
 243         req->rq_reqbuf->lm_buflens[segment] = newsize;
 244         newmsg_size = lustre_packed_msg_size(oldbuf);
 245         req->rq_reqbuf->lm_buflens[segment] = oldsize;
 246
 247         /* request from pool should always have enough buffer */
 248         LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
 249
 250         if (req->rq_reqbuf_len < newmsg_size) {
 251                 alloc_size = size_roundup_power2(newmsg_size);
 252
 253                 OBD_ALLOC_LARGE(newbuf, alloc_size);
 254                 if (newbuf == NULL)
 255                         return -ENOMEM;
 256
 257                 /* Must lock this, so that otherwise unprotected change of
 258                  * rq_reqmsg is not racing with parallel processing of
 259                  * imp_replay_list traversing threads. See LU-3333
 260                  * This is a bandaid at best, we really need to deal with this
 261                  * in request enlarging code before unpacking that's already
 262                  * there */
 263                 if (req->rq_import)
 264                         spin_lock(&req->rq_import->imp_lock);
 265                 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
 266
 267                 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
 268                 req->rq_reqbuf = req->rq_reqmsg = newbuf;
 269                 req->rq_reqbuf_len = alloc_size;
 270
 271                 if (req->rq_import)
 272                         spin_unlock(&req->rq_import->imp_lock);
 273         }
 274
 275         _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
 276         req->rq_reqlen = newmsg_size;
 277
 278         return 0;
 279 }
 280
 281 static struct ptlrpc_svc_ctx null_svc_ctx = {
 282         .sc_refcount    = ATOMIC_INIT(1),
 283         .sc_policy      = &null_policy,
 284 };
 285
 286 static
 287 int null_accept(struct ptlrpc_request *req)
 288 {
 289         LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
 290                 SPTLRPC_POLICY_NULL);
 291
 292         if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
 293                 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
 294                 return SECSVC_DROP;
 295         }
 296
 297         req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
 298
 299         req->rq_reqmsg = req->rq_reqbuf;
 300         req->rq_reqlen = req->rq_reqdata_len;
 301
 302         req->rq_svc_ctx = &null_svc_ctx;
 303         atomic_inc(&req->rq_svc_ctx->sc_refcount);
 304
 305         return SECSVC_OK;
 306 }
 307
 308 static
 309 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
 310 {
 311         struct ptlrpc_reply_state *rs;
 312         int rs_size = sizeof(*rs) + msgsize;
 313
 314         LASSERT(msgsize % 8 == 0);
 315
 316         rs = req->rq_reply_state;
 317
 318         if (rs) {
 319                 /* pre-allocated */
 320                 LASSERT(rs->rs_size >= rs_size);
 321         } else {
 322                 OBD_ALLOC_LARGE(rs, rs_size);
 323                 if (rs == NULL)
 324                         return -ENOMEM;
 325
 326                 rs->rs_size = rs_size;
 327         }
 328
 329         rs->rs_svc_ctx = req->rq_svc_ctx;
 330         atomic_inc(&req->rq_svc_ctx->sc_refcount);
 331
 332         rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
 333         rs->rs_repbuf_len = rs_size - sizeof(*rs);
 334         rs->rs_msg = rs->rs_repbuf;
 335
 336         req->rq_reply_state = rs;
 337         return 0;
 338 }
 339
 340 static
 341 void null_free_rs(struct ptlrpc_reply_state *rs)
 342 {
 343         LASSERT_ATOMIC_GT(&rs->rs_svc_ctx->sc_refcount, 1);
 344         atomic_dec(&rs->rs_svc_ctx->sc_refcount);
 345
 346         if (!rs->rs_prealloc)
 347                 OBD_FREE_LARGE(rs, rs->rs_size);
 348 }
 349
 350 static
 351 int null_authorize(struct ptlrpc_request *req)
 352 {
 353         struct ptlrpc_reply_state *rs = req->rq_reply_state;
 354
 355         LASSERT(rs);
 356
 357         rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
 358         rs->rs_repdata_len = req->rq_replen;
 359
 360         if (likely(req->rq_packed_final)) {
 361                 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
 362                         req->rq_reply_off = lustre_msg_early_size();
 363                 else
 364                         req->rq_reply_off = 0;
 365         } else {
 366                 __u32 cksum;
 367
 368                 cksum = lustre_msg_calc_cksum(rs->rs_repbuf);
 369                 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
 370                 req->rq_reply_off = 0;
 371         }
 372
 373         return 0;
 374 }
 375
 376 static struct ptlrpc_ctx_ops null_ctx_ops = {
 377         .refresh                = null_ctx_refresh,
 378         .sign                   = null_ctx_sign,
 379         .verify                 = null_ctx_verify,
 380 };
 381
 382 static struct ptlrpc_sec_cops null_sec_cops = {
 383         .create_sec             = null_create_sec,
 384         .destroy_sec            = null_destroy_sec,
 385         .lookup_ctx             = null_lookup_ctx,
 386         .flush_ctx_cache        = null_flush_ctx_cache,
 387         .alloc_reqbuf           = null_alloc_reqbuf,
 388         .alloc_repbuf           = null_alloc_repbuf,
 389         .free_reqbuf            = null_free_reqbuf,
 390         .free_repbuf            = null_free_repbuf,
 391         .enlarge_reqbuf         = null_enlarge_reqbuf,
 392 };
 393
 394 static struct ptlrpc_sec_sops null_sec_sops = {
 395         .accept                 = null_accept,
 396         .alloc_rs               = null_alloc_rs,
 397         .authorize              = null_authorize,
 398         .free_rs                = null_free_rs,
 399 };
 400
 401 static struct ptlrpc_sec_policy null_policy = {
 402         .sp_owner               = THIS_MODULE,
 403         .sp_name                = "sec.null",
 404         .sp_policy              = SPTLRPC_POLICY_NULL,
 405         .sp_cops                = &null_sec_cops,
 406         .sp_sops                = &null_sec_sops,
 407 };
 408
 409 static void null_init_internal(void)
 410 {
 411         static HLIST_HEAD(__list);
 412
 413         null_sec.ps_policy = &null_policy;
 414         atomic_set(&null_sec.ps_refcount, 1);   /* always busy */
 415         null_sec.ps_id = -1;
 416         null_sec.ps_import = NULL;
 417         null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
 418         null_sec.ps_flvr.sf_flags = 0;
 419         null_sec.ps_part = LUSTRE_SP_ANY;
 420         null_sec.ps_dying = 0;
 421         spin_lock_init(&null_sec.ps_lock);
 422         atomic_set(&null_sec.ps_nctx, 1);       /* for "null_cli_ctx" */
 423         INIT_LIST_HEAD(&null_sec.ps_gc_list);
 424         null_sec.ps_gc_interval = 0;
 425         null_sec.ps_gc_next = 0;
 426
 427         hlist_add_head(&null_cli_ctx.cc_cache, &__list);
 428         atomic_set(&null_cli_ctx.cc_refcount, 1);       /* for hash */
 429         null_cli_ctx.cc_sec = &null_sec;
 430         null_cli_ctx.cc_ops = &null_ctx_ops;
 431         null_cli_ctx.cc_expire = 0;
 432         null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
 433                                 PTLRPC_CTX_UPTODATE;
 434         null_cli_ctx.cc_vcred.vc_uid = 0;
 435         spin_lock_init(&null_cli_ctx.cc_lock);
 436         INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
 437         INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
 438 }
 439
 440 int sptlrpc_null_init(void)
 441 {
 442         int rc;
 443
 444         null_init_internal();
 445
 446         rc = sptlrpc_register_policy(&null_policy);
 447         if (rc)
 448                 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
 449
 450         return rc;
 451 }
 452
 453 void sptlrpc_null_fini(void)
 454 {
 455         int rc;
 456
 457         rc = sptlrpc_unregister_policy(&null_policy);
 458         if (rc)
 459                 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);
 460 }