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