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