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  * null sec temporarily use the third byte 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) << 16;
  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 >> 16) & 0xFF;
  77         case LUSTRE_MSG_MAGIC_V2_SWABBED:
  78                 return (msg->lm_secflvr >> 8) & 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_sec_part);
 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(RPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
 139
 140         if (sf->sf_bulk_ciph != BULK_CIPH_ALG_NULL ||
 141             sf->sf_bulk_hash != BULK_HASH_ALG_NULL) {
 142                 CERROR("null sec don't support bulk algorithm: %u/%u\n",
 143                        sf->sf_bulk_ciph, sf->sf_bulk_hash);
 144                 return NULL;
 145         }
 146
 147         /* general layer has take a module reference for us, because we never
 148          * really destroy the sec, simply release the reference here.
 149          */
 150         sptlrpc_policy_put(&null_policy);
 151         return &null_sec;
 152 }
 153
 154 static
 155 void null_destroy_sec(struct ptlrpc_sec *sec)
 156 {
 157         LASSERT(sec == &null_sec);
 158 }
 159
 160 static
 161 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
 162                                        struct vfs_cred *vcred,
 163                                        int create, int remove_dead)
 164 {
 165         atomic_inc(&null_cli_ctx.cc_refcount);
 166         return &null_cli_ctx;
 167 }
 168
 169 static
 170 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
 171                          uid_t uid,
 172                          int grace, int force)
 173 {
 174         return 0;
 175 }
 176
 177 static
 178 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
 179                       struct ptlrpc_request *req,
 180                       int msgsize)
 181 {
 182         if (!req->rq_reqbuf) {
 183                 int alloc_size = size_roundup_power2(msgsize);
 184
 185                 LASSERT(!req->rq_pool);
 186                 OBD_ALLOC(req->rq_reqbuf, alloc_size);
 187                 if (!req->rq_reqbuf)
 188                         return -ENOMEM;
 189
 190                 req->rq_reqbuf_len = alloc_size;
 191         } else {
 192                 LASSERT(req->rq_pool);
 193                 LASSERT(req->rq_reqbuf_len >= msgsize);
 194                 memset(req->rq_reqbuf, 0, msgsize);
 195         }
 196
 197         req->rq_reqmsg = req->rq_reqbuf;
 198         return 0;
 199 }
 200
 201 static
 202 void null_free_reqbuf(struct ptlrpc_sec *sec,
 203                       struct ptlrpc_request *req)
 204 {
 205         if (!req->rq_pool) {
 206                 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
 207                          "req %p: reqmsg %p is not reqbuf %p in null sec\n",
 208                          req, req->rq_reqmsg, req->rq_reqbuf);
 209                 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
 210                          "req %p: reqlen %d should smaller than buflen %d\n",
 211                          req, req->rq_reqlen, req->rq_reqbuf_len);
 212
 213                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
 214                 req->rq_reqmsg = req->rq_reqbuf = NULL;
 215                 req->rq_reqbuf_len = 0;
 216         }
 217
 218         req->rq_reqmsg = NULL;
 219 }
 220
 221 static
 222 int null_alloc_repbuf(struct ptlrpc_sec *sec,
 223                       struct ptlrpc_request *req,
 224                       int msgsize)
 225 {
 226         /* add space for early replied */
 227         msgsize += lustre_msg_early_size();
 228
 229         msgsize = size_roundup_power2(msgsize);
 230
 231         OBD_ALLOC(req->rq_repbuf, msgsize);
 232         if (!req->rq_repbuf)
 233                 return -ENOMEM;
 234
 235         req->rq_repbuf_len = msgsize;
 236         return 0;
 237 }
 238
 239 static
 240 void null_free_repbuf(struct ptlrpc_sec *sec,
 241                       struct ptlrpc_request *req)
 242 {
 243         LASSERT(req->rq_repbuf);
 244
 245         OBD_FREE(req->rq_repbuf, req->rq_repbuf_len);
 246         req->rq_repbuf = NULL;
 247         req->rq_repbuf_len = 0;
 248
 249         req->rq_repmsg = NULL;
 250 }
 251
 252 static
 253 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
 254                         struct ptlrpc_request *req,
 255                         int segment, int newsize)
 256 {
 257         struct lustre_msg      *newbuf;
 258         struct lustre_msg      *oldbuf = req->rq_reqmsg;
 259         int                     oldsize, newmsg_size, alloc_size;
 260
 261         LASSERT(req->rq_reqbuf);
 262         LASSERT(req->rq_reqbuf == req->rq_reqmsg);
 263         LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
 264         LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
 265
 266         /* compute new message size */
 267         oldsize = req->rq_reqbuf->lm_buflens[segment];
 268         req->rq_reqbuf->lm_buflens[segment] = newsize;
 269         newmsg_size = lustre_packed_msg_size(oldbuf);
 270         req->rq_reqbuf->lm_buflens[segment] = oldsize;
 271
 272         /* request from pool should always have enough buffer */
 273         LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
 274
 275         if (req->rq_reqbuf_len < newmsg_size) {
 276                 alloc_size = size_roundup_power2(newmsg_size);
 277
 278                 OBD_ALLOC(newbuf, alloc_size);
 279                 if (newbuf == NULL)
 280                         return -ENOMEM;
 281
 282                 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
 283
 284                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
 285                 req->rq_reqbuf = req->rq_reqmsg = newbuf;
 286                 req->rq_reqbuf_len = alloc_size;
 287         }
 288
 289         _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
 290         req->rq_reqlen = newmsg_size;
 291
 292         return 0;
 293 }
 294
 295 static struct ptlrpc_svc_ctx null_svc_ctx = {
 296         .sc_refcount    = ATOMIC_INIT(1),
 297         .sc_policy      = &null_policy,
 298 };
 299
 300 static
 301 int null_accept(struct ptlrpc_request *req)
 302 {
 303         LASSERT(RPC_FLVR_POLICY(req->rq_flvr.sf_rpc) == SPTLRPC_POLICY_NULL);
 304
 305         if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
 306                 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
 307                 return SECSVC_DROP;
 308         }
 309
 310         req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
 311
 312         req->rq_reqmsg = req->rq_reqbuf;
 313         req->rq_reqlen = req->rq_reqdata_len;
 314
 315         req->rq_svc_ctx = &null_svc_ctx;
 316         atomic_inc(&req->rq_svc_ctx->sc_refcount);
 317
 318         return SECSVC_OK;
 319 }
 320
 321 static
 322 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
 323 {
 324         struct ptlrpc_reply_state *rs;
 325         int rs_size = sizeof(*rs) + msgsize;
 326
 327         LASSERT(msgsize % 8 == 0);
 328
 329         rs = req->rq_reply_state;
 330
 331         if (rs) {
 332                 /* pre-allocated */
 333                 LASSERT(rs->rs_size >= rs_size);
 334         } else {
 335                 OBD_ALLOC(rs, rs_size);
 336                 if (rs == NULL)
 337                         return -ENOMEM;
 338
 339                 rs->rs_size = rs_size;
 340         }
 341
 342         rs->rs_svc_ctx = req->rq_svc_ctx;
 343         atomic_inc(&req->rq_svc_ctx->sc_refcount);
 344
 345         rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
 346         rs->rs_repbuf_len = rs_size - sizeof(*rs);
 347         rs->rs_msg = rs->rs_repbuf;
 348
 349         req->rq_reply_state = rs;
 350         return 0;
 351 }
 352
 353 static
 354 void null_free_rs(struct ptlrpc_reply_state *rs)
 355 {
 356         LASSERT(atomic_read(&rs->rs_svc_ctx->sc_refcount) > 1);
 357         atomic_dec(&rs->rs_svc_ctx->sc_refcount);
 358
 359         if (!rs->rs_prealloc)
 360                 OBD_FREE(rs, rs->rs_size);
 361 }
 362
 363 static
 364 int null_authorize(struct ptlrpc_request *req)
 365 {
 366         struct ptlrpc_reply_state *rs = req->rq_reply_state;
 367
 368         LASSERT(rs);
 369
 370         rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
 371         rs->rs_repdata_len = req->rq_replen;
 372
 373         if (likely(req->rq_packed_final)) {
 374                 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
 375                         req->rq_reply_off = lustre_msg_early_size();
 376                 else
 377                         req->rq_reply_off = 0;
 378         } else {
 379                 rs->rs_repbuf->lm_cksum =
 380                                 crc32_le(!(__u32) 0,
 381                                          (unsigned char *)rs->rs_repbuf,
 382                                          rs->rs_repdata_len);
 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 HLIST_HEAD(__list);
 425
 426         null_sec.ps_policy = &null_policy;
 427         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_bulk_ciph = BULK_CIPH_ALG_NULL;
 432         null_sec.ps_flvr.sf_bulk_hash = BULK_HASH_ALG_NULL;
 433         null_sec.ps_flvr.sf_flags = 0;
 434         null_sec.ps_part = LUSTRE_SP_ANY;
 435         null_sec.ps_dying = 0;
 436         spin_lock_init(&null_sec.ps_lock);
 437         atomic_set(&null_sec.ps_nctx, 1);         /* for "null_cli_ctx" */
 438         CFS_INIT_LIST_HEAD(&null_sec.ps_gc_list);
 439         null_sec.ps_gc_interval = 0;
 440         null_sec.ps_gc_next = 0;
 441
 442         hlist_add_head(&null_cli_ctx.cc_cache, &__list);
 443         atomic_set(&null_cli_ctx.cc_refcount, 1);    /* for hash */
 444         null_cli_ctx.cc_sec = &null_sec;
 445         null_cli_ctx.cc_ops = &null_ctx_ops;
 446         null_cli_ctx.cc_expire = 0;
 447         null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
 448                                 PTLRPC_CTX_UPTODATE;
 449         null_cli_ctx.cc_vcred.vc_uid = 0;
 450         spin_lock_init(&null_cli_ctx.cc_lock);
 451         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
 452         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
 453 }
 454
 455 int sptlrpc_null_init(void)
 456 {
 457         int rc;
 458
 459         null_init_internal();
 460
 461         rc = sptlrpc_register_policy(&null_policy);
 462         if (rc)
 463                 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
 464
 465         return rc;
 466 }
 467
 468 void sptlrpc_null_fini(void)
 469 {
 470         int rc;
 471
 472         rc = sptlrpc_unregister_policy(&null_policy);
 473         if (rc)
 474                 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);
 475 }