lustre/ptlrpc/sec_null.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/ptlrpc/sec_null.c
  37  *
  38  * Author: Eric Mei <ericm@clusterfs.com>
  39  */
  40
  41 #ifndef EXPORT_SYMTAB
  42 # define EXPORT_SYMTAB
  43 #endif
  44 #define DEBUG_SUBSYSTEM S_SEC
  45
  46 #ifndef __KERNEL__
  47 #include <liblustre.h>
  48 #endif
  49
  50 #include <obd_support.h>
  51 #include <obd_cksum.h>
  52 #include <obd_class.h>
  53 #include <lustre_net.h>
  54 #include <lustre_sec.h>
  55
  56 static struct ptlrpc_sec_policy null_policy;
  57 static struct ptlrpc_sec        null_sec;
  58 static struct ptlrpc_cli_ctx    null_cli_ctx;
  59 static struct ptlrpc_svc_ctx    null_svc_ctx;
  60
  61 /*
  62  * we can temporarily use the topmost 8-bits of lm_secflvr to identify
  63  * the source sec part.
  64  */
  65 static inline
  66 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
  67 {
  68         msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
  69 }
  70
  71 static inline
  72 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
  73 {
  74         return (msg->lm_secflvr >> 24) & 0xFF;
  75 }
  76
  77 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
  78 {
  79         /* should never reach here */
  80         LBUG();
  81         return 0;
  82 }
  83
  84 static
  85 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
  86 {
  87         req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
  88
  89         if (!req->rq_import->imp_dlm_fake) {
  90                 struct obd_device *obd = req->rq_import->imp_obd;
  91                 null_encode_sec_part(req->rq_reqbuf,
  92                                      obd->u.cli.cl_sp_me);
  93         }
  94         req->rq_reqdata_len = req->rq_reqlen;
  95         return 0;
  96 }
  97
  98 static
  99 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
 100 {
 101         __u32   cksums, cksumc;
 102
 103         LASSERT(req->rq_repdata);
 104
 105         req->rq_repmsg = req->rq_repdata;
 106         req->rq_replen = req->rq_repdata_len;
 107
 108         if (req->rq_early) {
 109                 cksums = lustre_msg_get_cksum(req->rq_repdata);
 110 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 9, 0, 0)
 111                 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
 112                     MSGHDR_CKSUM_INCOMPAT18)
 113                         cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 0);
 114                 else
 115                         cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 1);
 116 #else
 117 # warning "remove checksum compatibility support for b1_8"
 118                 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
 119 #endif
 120                 if (cksumc != cksums) {
 121                         CWARN("early reply checksum mismatch: %08x != %08x\n",
 122                               cksumc, cksums);
 123                         return -EINVAL;
 124                 }
 125         }
 126
 127         return 0;
 128 }
 129
 130 static
 131 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
 132                                    struct ptlrpc_svc_ctx *svc_ctx,
 133                                    struct sptlrpc_flavor *sf)
 134 {
 135         LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
 136
 137         /* general layer has take a module reference for us, because we never
 138          * really destroy the sec, simply release the reference here.
 139          */
 140         sptlrpc_policy_put(&null_policy);
 141         return &null_sec;
 142 }
 143
 144 static
 145 void null_destroy_sec(struct ptlrpc_sec *sec)
 146 {
 147         LASSERT(sec == &null_sec);
 148 }
 149
 150 static
 151 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
 152                                        struct vfs_cred *vcred,
 153                                        int create, int remove_dead)
 154 {
 155         cfs_atomic_inc(&null_cli_ctx.cc_refcount);
 156         return &null_cli_ctx;
 157 }
 158
 159 static
 160 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
 161                          uid_t uid,
 162                          int grace, int force)
 163 {
 164         return 0;
 165 }
 166
 167 static
 168 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
 169                       struct ptlrpc_request *req,
 170                       int msgsize)
 171 {
 172         if (!req->rq_reqbuf) {
 173                 int alloc_size = size_roundup_power2(msgsize);
 174
 175                 LASSERT(!req->rq_pool);
 176                 OBD_ALLOC(req->rq_reqbuf, alloc_size);
 177                 if (!req->rq_reqbuf)
 178                         return -ENOMEM;
 179
 180                 req->rq_reqbuf_len = alloc_size;
 181         } else {
 182                 LASSERT(req->rq_pool);
 183                 LASSERT(req->rq_reqbuf_len >= msgsize);
 184                 memset(req->rq_reqbuf, 0, msgsize);
 185         }
 186
 187         req->rq_reqmsg = req->rq_reqbuf;
 188         return 0;
 189 }
 190
 191 static
 192 void null_free_reqbuf(struct ptlrpc_sec *sec,
 193                       struct ptlrpc_request *req)
 194 {
 195         if (!req->rq_pool) {
 196                 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
 197                          "req %p: reqmsg %p is not reqbuf %p in null sec\n",
 198                          req, req->rq_reqmsg, req->rq_reqbuf);
 199                 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
 200                          "req %p: reqlen %d should smaller than buflen %d\n",
 201                          req, req->rq_reqlen, req->rq_reqbuf_len);
 202
 203                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
 204                 req->rq_reqmsg = req->rq_reqbuf = NULL;
 205                 req->rq_reqbuf_len = 0;
 206         }
 207
 208         req->rq_reqmsg = NULL;
 209 }
 210
 211 static
 212 int null_alloc_repbuf(struct ptlrpc_sec *sec,
 213                       struct ptlrpc_request *req,
 214                       int msgsize)
 215 {
 216         /* add space for early replied */
 217         msgsize += lustre_msg_early_size();
 218
 219         msgsize = size_roundup_power2(msgsize);
 220
 221         OBD_ALLOC(req->rq_repbuf, msgsize);
 222         if (!req->rq_repbuf)
 223                 return -ENOMEM;
 224
 225         req->rq_repbuf_len = msgsize;
 226         return 0;
 227 }
 228
 229 static
 230 void null_free_repbuf(struct ptlrpc_sec *sec,
 231                       struct ptlrpc_request *req)
 232 {
 233         LASSERT(req->rq_repbuf);
 234
 235         OBD_FREE(req->rq_repbuf, req->rq_repbuf_len);
 236         req->rq_repbuf = NULL;
 237         req->rq_repbuf_len = 0;
 238
 239         req->rq_repmsg = NULL;
 240 }
 241
 242 static
 243 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
 244                         struct ptlrpc_request *req,
 245                         int segment, int newsize)
 246 {
 247         struct lustre_msg      *newbuf;
 248         struct lustre_msg      *oldbuf = req->rq_reqmsg;
 249         int                     oldsize, newmsg_size, alloc_size;
 250
 251         LASSERT(req->rq_reqbuf);
 252         LASSERT(req->rq_reqbuf == req->rq_reqmsg);
 253         LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
 254         LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
 255
 256         /* compute new message size */
 257         oldsize = req->rq_reqbuf->lm_buflens[segment];
 258         req->rq_reqbuf->lm_buflens[segment] = newsize;
 259         newmsg_size = lustre_packed_msg_size(oldbuf);
 260         req->rq_reqbuf->lm_buflens[segment] = oldsize;
 261
 262         /* request from pool should always have enough buffer */
 263         LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
 264
 265         if (req->rq_reqbuf_len < newmsg_size) {
 266                 alloc_size = size_roundup_power2(newmsg_size);
 267
 268                 OBD_ALLOC(newbuf, alloc_size);
 269                 if (newbuf == NULL)
 270                         return -ENOMEM;
 271
 272                 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
 273
 274                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
 275                 req->rq_reqbuf = req->rq_reqmsg = newbuf;
 276                 req->rq_reqbuf_len = alloc_size;
 277         }
 278
 279         _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
 280         req->rq_reqlen = newmsg_size;
 281
 282         return 0;
 283 }
 284
 285 static struct ptlrpc_svc_ctx null_svc_ctx = {
 286         .sc_refcount    = CFS_ATOMIC_INIT(1),
 287         .sc_policy      = &null_policy,
 288 };
 289
 290 static
 291 int null_accept(struct ptlrpc_request *req)
 292 {
 293         LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
 294                 SPTLRPC_POLICY_NULL);
 295
 296         if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
 297                 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
 298                 return SECSVC_DROP;
 299         }
 300
 301         req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
 302
 303         req->rq_reqmsg = req->rq_reqbuf;
 304         req->rq_reqlen = req->rq_reqdata_len;
 305
 306         req->rq_svc_ctx = &null_svc_ctx;
 307         cfs_atomic_inc(&req->rq_svc_ctx->sc_refcount);
 308
 309         return SECSVC_OK;
 310 }
 311
 312 static
 313 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
 314 {
 315         struct ptlrpc_reply_state *rs;
 316         int rs_size = sizeof(*rs) + msgsize;
 317
 318         LASSERT(msgsize % 8 == 0);
 319
 320         rs = req->rq_reply_state;
 321
 322         if (rs) {
 323                 /* pre-allocated */
 324                 LASSERT(rs->rs_size >= rs_size);
 325         } else {
 326                 OBD_ALLOC(rs, rs_size);
 327                 if (rs == NULL)
 328                         return -ENOMEM;
 329
 330                 rs->rs_size = rs_size;
 331         }
 332
 333         rs->rs_svc_ctx = req->rq_svc_ctx;
 334         cfs_atomic_inc(&req->rq_svc_ctx->sc_refcount);
 335
 336         rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
 337         rs->rs_repbuf_len = rs_size - sizeof(*rs);
 338         rs->rs_msg = rs->rs_repbuf;
 339
 340         req->rq_reply_state = rs;
 341         return 0;
 342 }
 343
 344 static
 345 void null_free_rs(struct ptlrpc_reply_state *rs)
 346 {
 347         LASSERT(cfs_atomic_read(&rs->rs_svc_ctx->sc_refcount) > 1);
 348         cfs_atomic_dec(&rs->rs_svc_ctx->sc_refcount);
 349
 350         if (!rs->rs_prealloc)
 351                 OBD_FREE(rs, rs->rs_size);
 352 }
 353
 354 static
 355 int null_authorize(struct ptlrpc_request *req)
 356 {
 357         struct ptlrpc_reply_state *rs = req->rq_reply_state;
 358
 359         LASSERT(rs);
 360
 361         rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
 362         rs->rs_repdata_len = req->rq_replen;
 363
 364         if (likely(req->rq_packed_final)) {
 365                 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
 366                         req->rq_reply_off = lustre_msg_early_size();
 367                 else
 368                         req->rq_reply_off = 0;
 369         } else {
 370                 __u32 cksum;
 371
 372 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 9, 0, 0)
 373                 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
 374                     MSGHDR_CKSUM_INCOMPAT18)
 375                         cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 0);
 376                 else
 377                         cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 1);
 378 #else
 379 # warning "remove checksum compatibility support for b1_8"
 380                 cksum = lustre_msg_calc_cksum(rs->rs_repbuf);
 381 #endif
 382                 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
 383                 req->rq_reply_off = 0;
 384         }
 385
 386         return 0;
 387 }
 388
 389 static struct ptlrpc_ctx_ops null_ctx_ops = {
 390         .refresh                = null_ctx_refresh,
 391         .sign                   = null_ctx_sign,
 392         .verify                 = null_ctx_verify,
 393 };
 394
 395 static struct ptlrpc_sec_cops null_sec_cops = {
 396         .create_sec             = null_create_sec,
 397         .destroy_sec            = null_destroy_sec,
 398         .lookup_ctx             = null_lookup_ctx,
 399         .flush_ctx_cache        = null_flush_ctx_cache,
 400         .alloc_reqbuf           = null_alloc_reqbuf,
 401         .alloc_repbuf           = null_alloc_repbuf,
 402         .free_reqbuf            = null_free_reqbuf,
 403         .free_repbuf            = null_free_repbuf,
 404         .enlarge_reqbuf         = null_enlarge_reqbuf,
 405 };
 406
 407 static struct ptlrpc_sec_sops null_sec_sops = {
 408         .accept                 = null_accept,
 409         .alloc_rs               = null_alloc_rs,
 410         .authorize              = null_authorize,
 411         .free_rs                = null_free_rs,
 412 };
 413
 414 static struct ptlrpc_sec_policy null_policy = {
 415         .sp_owner               = THIS_MODULE,
 416         .sp_name                = "sec.null",
 417         .sp_policy              = SPTLRPC_POLICY_NULL,
 418         .sp_cops                = &null_sec_cops,
 419         .sp_sops                = &null_sec_sops,
 420 };
 421
 422 static void null_init_internal(void)
 423 {
 424         static CFS_HLIST_HEAD(__list);
 425
 426         null_sec.ps_policy = &null_policy;
 427         cfs_atomic_set(&null_sec.ps_refcount, 1);     /* always busy */
 428         null_sec.ps_id = -1;
 429         null_sec.ps_import = NULL;
 430         null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
 431         null_sec.ps_flvr.sf_flags = 0;
 432         null_sec.ps_part = LUSTRE_SP_ANY;
 433         null_sec.ps_dying = 0;
 434         cfs_spin_lock_init(&null_sec.ps_lock);
 435         cfs_atomic_set(&null_sec.ps_nctx, 1);         /* for "null_cli_ctx" */
 436         CFS_INIT_LIST_HEAD(&null_sec.ps_gc_list);
 437         null_sec.ps_gc_interval = 0;
 438         null_sec.ps_gc_next = 0;
 439
 440         cfs_hlist_add_head(&null_cli_ctx.cc_cache, &__list);
 441         cfs_atomic_set(&null_cli_ctx.cc_refcount, 1);    /* for hash */
 442         null_cli_ctx.cc_sec = &null_sec;
 443         null_cli_ctx.cc_ops = &null_ctx_ops;
 444         null_cli_ctx.cc_expire = 0;
 445         null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
 446                                 PTLRPC_CTX_UPTODATE;
 447         null_cli_ctx.cc_vcred.vc_uid = 0;
 448         cfs_spin_lock_init(&null_cli_ctx.cc_lock);
 449         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
 450         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
 451 }
 452
 453 int sptlrpc_null_init(void)
 454 {
 455         int rc;
 456
 457         null_init_internal();
 458
 459         rc = sptlrpc_register_policy(&null_policy);
 460         if (rc)
 461                 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
 462
 463         return rc;
 464 }
 465
 466 void sptlrpc_null_fini(void)
 467 {
 468         int rc;
 469
 470         rc = sptlrpc_unregister_policy(&null_policy);
 471         if (rc)
 472                 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);
 473 }