drivers/staging/lustre/lustre/include/lustre_sec.h

   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) 2012, 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
  37 #ifndef _LUSTRE_SEC_H_
  38 #define _LUSTRE_SEC_H_
  39
  40 /** \defgroup sptlrpc sptlrpc
  41  *
  42  * @{
  43  */
  44
  45 /*
  46  * to avoid include
  47  */
  48 struct obd_import;
  49 struct obd_export;
  50 struct ptlrpc_request;
  51 struct ptlrpc_reply_state;
  52 struct ptlrpc_bulk_desc;
  53 struct brw_page;
  54 /* Linux specific */
  55 struct key;
  56 struct seq_file;
  57
  58 /*
  59  * forward declaration
  60  */
  61 struct ptlrpc_sec_policy;
  62 struct ptlrpc_sec_cops;
  63 struct ptlrpc_sec_sops;
  64 struct ptlrpc_sec;
  65 struct ptlrpc_svc_ctx;
  66 struct ptlrpc_cli_ctx;
  67 struct ptlrpc_ctx_ops;
  68
  69 /**
  70  * \addtogroup flavor flavor
  71  *
  72  * RPC flavor is represented by a 32 bits integer. Currently the high 12 bits
  73  * are unused, must be set to 0 for future expansion.
  74  * <pre>
  75  * ------------------------------------------------------------------------
  76  * | 4b (bulk svc) | 4b (bulk type) | 4b (svc) | 4b (mech)  | 4b (policy) |
  77  * ------------------------------------------------------------------------
  78  * </pre>
  79  *
  80  * @{
  81  */
  82
  83 /*
  84  * flavor constants
  85  */
  86 enum sptlrpc_policy {
  87         SPTLRPC_POLICY_NULL          = 0,
  88         SPTLRPC_POLICY_PLAIN        = 1,
  89         SPTLRPC_POLICY_GSS            = 2,
  90         SPTLRPC_POLICY_MAX,
  91 };
  92
  93 enum sptlrpc_mech_null {
  94         SPTLRPC_MECH_NULL              = 0,
  95         SPTLRPC_MECH_NULL_MAX,
  96 };
  97
  98 enum sptlrpc_mech_plain {
  99         SPTLRPC_MECH_PLAIN            = 0,
 100         SPTLRPC_MECH_PLAIN_MAX,
 101 };
 102
 103 enum sptlrpc_mech_gss {
 104         SPTLRPC_MECH_GSS_NULL      = 0,
 105         SPTLRPC_MECH_GSS_KRB5      = 1,
 106         SPTLRPC_MECH_GSS_MAX,
 107 };
 108
 109 enum sptlrpc_service_type {
 110         SPTLRPC_SVC_NULL                = 0,    /**< no security */
 111         SPTLRPC_SVC_AUTH                = 1,    /**< authentication only */
 112         SPTLRPC_SVC_INTG                = 2,    /**< integrity */
 113         SPTLRPC_SVC_PRIV                = 3,    /**< privacy */
 114         SPTLRPC_SVC_MAX,
 115 };
 116
 117 enum sptlrpc_bulk_type {
 118         SPTLRPC_BULK_DEFAULT        = 0,    /**< follow rpc flavor */
 119         SPTLRPC_BULK_HASH              = 1,    /**< hash integrity */
 120         SPTLRPC_BULK_MAX,
 121 };
 122
 123 enum sptlrpc_bulk_service {
 124         SPTLRPC_BULK_SVC_NULL      = 0,    /**< no security */
 125         SPTLRPC_BULK_SVC_AUTH      = 1,    /**< authentication only */
 126         SPTLRPC_BULK_SVC_INTG      = 2,    /**< integrity */
 127         SPTLRPC_BULK_SVC_PRIV      = 3,    /**< privacy */
 128         SPTLRPC_BULK_SVC_MAX,
 129 };
 130
 131 /*
 132  * compose/extract macros
 133  */
 134 #define FLVR_POLICY_OFFSET            (0)
 135 #define FLVR_MECH_OFFSET                (4)
 136 #define FLVR_SVC_OFFSET          (8)
 137 #define FLVR_BULK_TYPE_OFFSET      (12)
 138 #define FLVR_BULK_SVC_OFFSET        (16)
 139
 140 #define MAKE_FLVR(policy, mech, svc, btype, bsvc)                      \
 141         (((__u32)(policy) << FLVR_POLICY_OFFSET) |                    \
 142          ((__u32)(mech) << FLVR_MECH_OFFSET) |                    \
 143          ((__u32)(svc) << FLVR_SVC_OFFSET) |                        \
 144          ((__u32)(btype) << FLVR_BULK_TYPE_OFFSET) |                \
 145          ((__u32)(bsvc) << FLVR_BULK_SVC_OFFSET))
 146
 147 /*
 148  * extraction
 149  */
 150 #define SPTLRPC_FLVR_POLICY(flavor)                                  \
 151         ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xF)
 152 #define SPTLRPC_FLVR_MECH(flavor)                                      \
 153         ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xF)
 154 #define SPTLRPC_FLVR_SVC(flavor)                                        \
 155         ((((__u32)(flavor)) >> FLVR_SVC_OFFSET) & 0xF)
 156 #define SPTLRPC_FLVR_BULK_TYPE(flavor)                            \
 157         ((((__u32)(flavor)) >> FLVR_BULK_TYPE_OFFSET) & 0xF)
 158 #define SPTLRPC_FLVR_BULK_SVC(flavor)                              \
 159         ((((__u32)(flavor)) >> FLVR_BULK_SVC_OFFSET) & 0xF)
 160
 161 #define SPTLRPC_FLVR_BASE(flavor)                                      \
 162         ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xFFF)
 163 #define SPTLRPC_FLVR_BASE_SUB(flavor)                              \
 164         ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xFF)
 165
 166 /*
 167  * gss subflavors
 168  */
 169 #define MAKE_BASE_SUBFLVR(mech, svc)                                \
 170         ((__u32)(mech) |                                                \
 171          ((__u32)(svc) << (FLVR_SVC_OFFSET - FLVR_MECH_OFFSET)))
 172
 173 #define SPTLRPC_SUBFLVR_KRB5N                                      \
 174         MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_NULL)
 175 #define SPTLRPC_SUBFLVR_KRB5A                                      \
 176         MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_AUTH)
 177 #define SPTLRPC_SUBFLVR_KRB5I                                      \
 178         MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_INTG)
 179 #define SPTLRPC_SUBFLVR_KRB5P                                      \
 180         MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_PRIV)
 181
 182 /*
 183  * "end user" flavors
 184  */
 185 #define SPTLRPC_FLVR_NULL                              \
 186         MAKE_FLVR(SPTLRPC_POLICY_NULL,            \
 187                   SPTLRPC_MECH_NULL,                \
 188                   SPTLRPC_SVC_NULL,                  \
 189                   SPTLRPC_BULK_DEFAULT,          \
 190                   SPTLRPC_BULK_SVC_NULL)
 191 #define SPTLRPC_FLVR_PLAIN                            \
 192         MAKE_FLVR(SPTLRPC_POLICY_PLAIN,          \
 193                   SPTLRPC_MECH_PLAIN,              \
 194                   SPTLRPC_SVC_NULL,                  \
 195                   SPTLRPC_BULK_HASH,                \
 196                   SPTLRPC_BULK_SVC_INTG)
 197 #define SPTLRPC_FLVR_KRB5N                            \
 198         MAKE_FLVR(SPTLRPC_POLICY_GSS,              \
 199                   SPTLRPC_MECH_GSS_KRB5,                \
 200                   SPTLRPC_SVC_NULL,                  \
 201                   SPTLRPC_BULK_DEFAULT,          \
 202                   SPTLRPC_BULK_SVC_NULL)
 203 #define SPTLRPC_FLVR_KRB5A                            \
 204         MAKE_FLVR(SPTLRPC_POLICY_GSS,              \
 205                   SPTLRPC_MECH_GSS_KRB5,                \
 206                   SPTLRPC_SVC_AUTH,                  \
 207                   SPTLRPC_BULK_DEFAULT,          \
 208                   SPTLRPC_BULK_SVC_NULL)
 209 #define SPTLRPC_FLVR_KRB5I                            \
 210         MAKE_FLVR(SPTLRPC_POLICY_GSS,              \
 211                   SPTLRPC_MECH_GSS_KRB5,                \
 212                   SPTLRPC_SVC_INTG,                  \
 213                   SPTLRPC_BULK_DEFAULT,          \
 214                   SPTLRPC_BULK_SVC_INTG)
 215 #define SPTLRPC_FLVR_KRB5P                            \
 216         MAKE_FLVR(SPTLRPC_POLICY_GSS,              \
 217                   SPTLRPC_MECH_GSS_KRB5,                \
 218                   SPTLRPC_SVC_PRIV,                  \
 219                   SPTLRPC_BULK_DEFAULT,          \
 220                   SPTLRPC_BULK_SVC_PRIV)
 221
 222 #define SPTLRPC_FLVR_DEFAULT        SPTLRPC_FLVR_NULL
 223
 224 #define SPTLRPC_FLVR_INVALID        ((__u32) 0xFFFFFFFF)
 225 #define SPTLRPC_FLVR_ANY                ((__u32) 0xFFF00000)
 226
 227 /**
 228  * extract the useful part from wire flavor
 229  */
 230 #define WIRE_FLVR(wflvr)                (((__u32) (wflvr)) & 0x000FFFFF)
 231
 232 /** @} flavor */
 233
 234 static inline void flvr_set_svc(__u32 *flvr, __u32 svc)
 235 {
 236         LASSERT(svc < SPTLRPC_SVC_MAX);
 237         *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
 238                           SPTLRPC_FLVR_MECH(*flvr),
 239                           svc,
 240                           SPTLRPC_FLVR_BULK_TYPE(*flvr),
 241                           SPTLRPC_FLVR_BULK_SVC(*flvr));
 242 }
 243
 244 static inline void flvr_set_bulk_svc(__u32 *flvr, __u32 svc)
 245 {
 246         LASSERT(svc < SPTLRPC_BULK_SVC_MAX);
 247         *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
 248                           SPTLRPC_FLVR_MECH(*flvr),
 249                           SPTLRPC_FLVR_SVC(*flvr),
 250                           SPTLRPC_FLVR_BULK_TYPE(*flvr),
 251                           svc);
 252 }
 253
 254 struct bulk_spec_hash {
 255         __u8    hash_alg;
 256 };
 257
 258 /**
 259  * Full description of flavors being used on a ptlrpc connection, include
 260  * both regular RPC and bulk transfer parts.
 261  */
 262 struct sptlrpc_flavor {
 263         /**
 264          * wire flavor, should be renamed to sf_wire.
 265          */
 266         __u32   sf_rpc;
 267         /**
 268          * general flags of PTLRPC_SEC_FL_*
 269          */
 270         __u32   sf_flags;
 271         /**
 272          * rpc flavor specification
 273          */
 274         union {
 275                 /* nothing for now */
 276         } u_rpc;
 277         /**
 278          * bulk flavor specification
 279          */
 280         union {
 281                 struct bulk_spec_hash hash;
 282         } u_bulk;
 283 };
 284
 285 /**
 286  * identify the RPC is generated from what part of Lustre. It's encoded into
 287  * RPC requests and to be checked by ptlrpc service.
 288  */
 289 enum lustre_sec_part {
 290         LUSTRE_SP_CLI      = 0,
 291         LUSTRE_SP_MDT,
 292         LUSTRE_SP_OST,
 293         LUSTRE_SP_MGC,
 294         LUSTRE_SP_MGS,
 295         LUSTRE_SP_ANY      = 0xFF
 296 };
 297
 298 enum lustre_sec_part sptlrpc_target_sec_part(struct obd_device *obd);
 299
 300 /**
 301  * A rule specifies a flavor to be used by a ptlrpc connection between
 302  * two Lustre parts.
 303  */
 304 struct sptlrpc_rule {
 305         __u32              sr_netid;   /* LNET network ID */
 306         __u8                sr_from;    /* sec_part */
 307         __u8                sr_to;      /* sec_part */
 308         __u16              sr_padding;
 309         struct sptlrpc_flavor   sr_flvr;
 310 };
 311
 312 /**
 313  * A set of rules in memory.
 314  *
 315  * Rules are generated and stored on MGS, and propagated to MDT, OST,
 316  * and client when needed.
 317  */
 318 struct sptlrpc_rule_set {
 319         int                  srs_nslot;
 320         int                  srs_nrule;
 321         struct sptlrpc_rule    *srs_rules;
 322 };
 323
 324 int sptlrpc_parse_flavor(const char *str, struct sptlrpc_flavor *flvr);
 325 int sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr);
 326
 327 static inline void sptlrpc_rule_set_init(struct sptlrpc_rule_set *set)
 328 {
 329         memset(set, 0, sizeof(*set));
 330 }
 331
 332 int  sptlrpc_process_config(struct lustre_cfg *lcfg);
 333 void sptlrpc_conf_log_start(const char *logname);
 334 void sptlrpc_conf_log_stop(const char *logname);
 335 void sptlrpc_conf_log_update_begin(const char *logname);
 336 void sptlrpc_conf_log_update_end(const char *logname);
 337 void sptlrpc_conf_client_adapt(struct obd_device *obd);
 338
 339 /* The maximum length of security payload. 1024 is enough for Kerberos 5,
 340  * and should be enough for other future mechanisms but not sure.
 341  * Only used by pre-allocated request/reply pool.
 342  */
 343 #define SPTLRPC_MAX_PAYLOAD     (1024)
 344
 345
 346 struct vfs_cred {
 347         uint32_t        vc_uid;
 348         uint32_t        vc_gid;
 349 };
 350
 351 struct ptlrpc_ctx_ops {
 352         /**
 353          * To determine whether it's suitable to use the \a ctx for \a vcred.
 354          */
 355         int     (*match)       (struct ptlrpc_cli_ctx *ctx,
 356                                 struct vfs_cred *vcred);
 357
 358         /**
 359          * To bring the \a ctx uptodate.
 360          */
 361         int     (*refresh)     (struct ptlrpc_cli_ctx *ctx);
 362
 363         /**
 364          * Validate the \a ctx.
 365          */
 366         int     (*validate)    (struct ptlrpc_cli_ctx *ctx);
 367
 368         /**
 369          * Force the \a ctx to die.
 370          */
 371         void    (*force_die)   (struct ptlrpc_cli_ctx *ctx,
 372                                 int grace);
 373         int     (*display)     (struct ptlrpc_cli_ctx *ctx,
 374                                 char *buf, int bufsize);
 375
 376         /**
 377          * Sign the request message using \a ctx.
 378          *
 379          * \pre req->rq_reqmsg point to request message.
 380          * \pre req->rq_reqlen is the request message length.
 381          * \post req->rq_reqbuf point to request message with signature.
 382          * \post req->rq_reqdata_len is set to the final request message size.
 383          *
 384          * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
 385          */
 386         int     (*sign) (struct ptlrpc_cli_ctx *ctx,
 387                                 struct ptlrpc_request *req);
 388
 389         /**
 390          * Verify the reply message using \a ctx.
 391          *
 392          * \pre req->rq_repdata point to reply message with signature.
 393          * \pre req->rq_repdata_len is the total reply message length.
 394          * \post req->rq_repmsg point to reply message without signature.
 395          * \post req->rq_replen is the reply message length.
 396          *
 397          * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
 398          */
 399         int     (*verify)      (struct ptlrpc_cli_ctx *ctx,
 400                                 struct ptlrpc_request *req);
 401
 402         /**
 403          * Encrypt the request message using \a ctx.
 404          *
 405          * \pre req->rq_reqmsg point to request message in clear text.
 406          * \pre req->rq_reqlen is the request message length.
 407          * \post req->rq_reqbuf point to request message.
 408          * \post req->rq_reqdata_len is set to the final request message size.
 409          *
 410          * \see gss_cli_ctx_seal().
 411          */
 412         int     (*seal) (struct ptlrpc_cli_ctx *ctx,
 413                                 struct ptlrpc_request *req);
 414
 415         /**
 416          * Decrypt the reply message using \a ctx.
 417          *
 418          * \pre req->rq_repdata point to encrypted reply message.
 419          * \pre req->rq_repdata_len is the total cipher text length.
 420          * \post req->rq_repmsg point to reply message in clear text.
 421          * \post req->rq_replen is the reply message length in clear text.
 422          *
 423          * \see gss_cli_ctx_unseal().
 424          */
 425         int     (*unseal)      (struct ptlrpc_cli_ctx *ctx,
 426                                 struct ptlrpc_request *req);
 427
 428         /**
 429          * Wrap bulk request data. This is called before wrapping RPC
 430          * request message.
 431          *
 432          * \pre bulk buffer is descripted by desc->bd_iov and
 433          * desc->bd_iov_count. note for read it's just buffer, no data
 434          * need to be sent;  for write it contains data in clear text.
 435          * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
 436          * (usually inside of RPC request message).
 437          * - encryption: cipher text bulk buffer is descripted by
 438          *   desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
 439          *   count remains the same).
 440          * - otherwise: bulk buffer is still desc->bd_iov and
 441          *   desc->bd_iov_count.
 442          *
 443          * \return 0: success.
 444          * \return -ev: error code.
 445          *
 446          * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
 447          */
 448         int     (*wrap_bulk)   (struct ptlrpc_cli_ctx *ctx,
 449                                 struct ptlrpc_request *req,
 450                                 struct ptlrpc_bulk_desc *desc);
 451
 452         /**
 453          * Unwrap bulk reply data. This is called after wrapping RPC
 454          * reply message.
 455          *
 456          * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
 457          * desc->bd_iov_count, according to wrap_bulk().
 458          * \post final bulk data in clear text is placed in buffer described
 459          * by desc->bd_iov and desc->bd_iov_count.
 460          * \return +ve nob of actual bulk data in clear text.
 461          * \return -ve error code.
 462          *
 463          * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
 464          */
 465         int     (*unwrap_bulk) (struct ptlrpc_cli_ctx *ctx,
 466                                 struct ptlrpc_request *req,
 467                                 struct ptlrpc_bulk_desc *desc);
 468 };
 469
 470 #define PTLRPC_CTX_NEW_BIT           (0)  /* newly created */
 471 #define PTLRPC_CTX_UPTODATE_BIT (1)  /* uptodate */
 472 #define PTLRPC_CTX_DEAD_BIT         (2)  /* mark expired gracefully */
 473 #define PTLRPC_CTX_ERROR_BIT       (3)  /* fatal error (refresh, etc.) */
 474 #define PTLRPC_CTX_CACHED_BIT     (8)  /* in ctx cache (hash etc.) */
 475 #define PTLRPC_CTX_ETERNAL_BIT   (9)  /* always valid */
 476
 477 #define PTLRPC_CTX_NEW           (1 << PTLRPC_CTX_NEW_BIT)
 478 #define PTLRPC_CTX_UPTODATE         (1 << PTLRPC_CTX_UPTODATE_BIT)
 479 #define PTLRPC_CTX_DEAD         (1 << PTLRPC_CTX_DEAD_BIT)
 480 #define PTLRPC_CTX_ERROR               (1 << PTLRPC_CTX_ERROR_BIT)
 481 #define PTLRPC_CTX_CACHED             (1 << PTLRPC_CTX_CACHED_BIT)
 482 #define PTLRPC_CTX_ETERNAL           (1 << PTLRPC_CTX_ETERNAL_BIT)
 483
 484 #define PTLRPC_CTX_STATUS_MASK   (PTLRPC_CTX_NEW_BIT    |       \
 485                                         PTLRPC_CTX_UPTODATE   |       \
 486                                         PTLRPC_CTX_DEAD       |       \
 487                                         PTLRPC_CTX_ERROR)
 488
 489 struct ptlrpc_cli_ctx {
 490         struct hlist_node       cc_cache;      /* linked into ctx cache */
 491         atomic_t            cc_refcount;
 492         struct ptlrpc_sec      *cc_sec;
 493         struct ptlrpc_ctx_ops  *cc_ops;
 494         unsigned long         cc_expire;     /* in seconds */
 495         unsigned int        cc_early_expire:1;
 496         unsigned long      cc_flags;
 497         struct vfs_cred  cc_vcred;
 498         spinlock_t              cc_lock;
 499         struct list_head              cc_req_list;   /* waiting reqs linked here */
 500         struct list_head              cc_gc_chain;   /* linked to gc chain */
 501 };
 502
 503 /**
 504  * client side policy operation vector.
 505  */
 506 struct ptlrpc_sec_cops {
 507         /**
 508          * Given an \a imp, create and initialize a ptlrpc_sec structure.
 509          * \param ctx service context:
 510          * - regular import: \a ctx should be NULL;
 511          * - reverse import: \a ctx is obtained from incoming request.
 512          * \param flavor specify what flavor to use.
 513          *
 514          * When necessary, policy module is responsible for taking reference
 515          * on the import.
 516          *
 517          * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
 518          */
 519         struct ptlrpc_sec *     (*create_sec)  (struct obd_import *imp,
 520                                                 struct ptlrpc_svc_ctx *ctx,
 521                                                 struct sptlrpc_flavor *flavor);
 522
 523         /**
 524          * Destructor of ptlrpc_sec. When called, refcount has been dropped
 525          * to 0 and all contexts has been destroyed.
 526          *
 527          * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
 528          */
 529         void                (*destroy_sec) (struct ptlrpc_sec *sec);
 530
 531         /**
 532          * Notify that this ptlrpc_sec is going to die. Optionally, policy
 533          * module is supposed to set sec->ps_dying and whatever necessary
 534          * actions.
 535          *
 536          * \see plain_kill_sec(), gss_sec_kill().
 537          */
 538         void                (*kill_sec)    (struct ptlrpc_sec *sec);
 539
 540         /**
 541          * Given \a vcred, lookup and/or create its context. The policy module
 542          * is supposed to maintain its own context cache.
 543          * XXX currently \a create and \a remove_dead is always 1, perhaps
 544          * should be removed completely.
 545          *
 546          * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
 547          */
 548         struct ptlrpc_cli_ctx * (*lookup_ctx)  (struct ptlrpc_sec *sec,
 549                                                 struct vfs_cred *vcred,
 550                                                 int create,
 551                                                 int remove_dead);
 552
 553         /**
 554          * Called then the reference of \a ctx dropped to 0. The policy module
 555          * is supposed to destroy this context or whatever else according to
 556          * its cache maintenance mechanism.
 557          *
 558          * \param sync if zero, we shouldn't wait for the context being
 559          * destroyed completely.
 560          *
 561          * \see plain_release_ctx(), gss_sec_release_ctx_kr().
 562          */
 563         void                (*release_ctx) (struct ptlrpc_sec *sec,
 564                                                 struct ptlrpc_cli_ctx *ctx,
 565                                                 int sync);
 566
 567         /**
 568          * Flush the context cache.
 569          *
 570          * \param uid context of which user, -1 means all contexts.
 571          * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
 572          * contexts should be cleared immediately.
 573          * \param force if zero, only idle contexts will be flushed.
 574          *
 575          * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
 576          */
 577         int                  (*flush_ctx_cache)
 578                                                (struct ptlrpc_sec *sec,
 579                                                 uid_t uid,
 580                                                 int grace,
 581                                                 int force);
 582
 583         /**
 584          * Called periodically by garbage collector to remove dead contexts
 585          * from cache.
 586          *
 587          * \see gss_sec_gc_ctx_kr().
 588          */
 589         void                (*gc_ctx)      (struct ptlrpc_sec *sec);
 590
 591         /**
 592          * Given an context \a ctx, install a corresponding reverse service
 593          * context on client side.
 594          * XXX currently it's only used by GSS module, maybe we should remove
 595          * this from general API.
 596          */
 597         int                  (*install_rctx)(struct obd_import *imp,
 598                                                 struct ptlrpc_sec *sec,
 599                                                 struct ptlrpc_cli_ctx *ctx);
 600
 601         /**
 602          * To allocate request buffer for \a req.
 603          *
 604          * \pre req->rq_reqmsg == NULL.
 605          * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
 606          * we are not supposed to free it.
 607          * \post if success, req->rq_reqmsg point to a buffer with size
 608          * at least \a lustre_msg_size.
 609          *
 610          * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
 611          */
 612         int                  (*alloc_reqbuf)(struct ptlrpc_sec *sec,
 613                                                 struct ptlrpc_request *req,
 614                                                 int lustre_msg_size);
 615
 616         /**
 617          * To free request buffer for \a req.
 618          *
 619          * \pre req->rq_reqbuf != NULL.
 620          *
 621          * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
 622          */
 623         void                (*free_reqbuf) (struct ptlrpc_sec *sec,
 624                                                 struct ptlrpc_request *req);
 625
 626         /**
 627          * To allocate reply buffer for \a req.
 628          *
 629          * \pre req->rq_repbuf == NULL.
 630          * \post if success, req->rq_repbuf point to a buffer with size
 631          * req->rq_repbuf_len, the size should be large enough to receive
 632          * reply which be transformed from \a lustre_msg_size of clear text.
 633          *
 634          * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
 635          */
 636         int                  (*alloc_repbuf)(struct ptlrpc_sec *sec,
 637                                                 struct ptlrpc_request *req,
 638                                                 int lustre_msg_size);
 639
 640         /**
 641          * To free reply buffer for \a req.
 642          *
 643          * \pre req->rq_repbuf != NULL.
 644          * \post req->rq_repbuf == NULL.
 645          * \post req->rq_repbuf_len == 0.
 646          *
 647          * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
 648          */
 649         void                (*free_repbuf) (struct ptlrpc_sec *sec,
 650                                                 struct ptlrpc_request *req);
 651
 652         /**
 653          * To expand the request buffer of \a req, thus the \a segment in
 654          * the request message pointed by req->rq_reqmsg can accommodate
 655          * at least \a newsize of data.
 656          *
 657          * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
 658          *
 659          * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
 660          * gss_enlarge_reqbuf().
 661          */
 662         int                  (*enlarge_reqbuf)
 663                                                (struct ptlrpc_sec *sec,
 664                                                 struct ptlrpc_request *req,
 665                                                 int segment, int newsize);
 666         /*
 667          * misc
 668          */
 669         int                  (*display)     (struct ptlrpc_sec *sec,
 670                                                 struct seq_file *seq);
 671 };
 672
 673 /**
 674  * server side policy operation vector.
 675  */
 676 struct ptlrpc_sec_sops {
 677         /**
 678          * verify an incoming request.
 679          *
 680          * \pre request message is pointed by req->rq_reqbuf, size is
 681          * req->rq_reqdata_len; and the message has been unpacked to
 682          * host byte order.
 683          *
 684          * \retval SECSVC_OK success, req->rq_reqmsg point to request message
 685          * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
 686          * req->rq_sp_from is decoded from request.
 687          * \retval SECSVC_COMPLETE success, the request has been fully
 688          * processed, and reply message has been prepared; req->rq_sp_from is
 689          * decoded from request.
 690          * \retval SECSVC_DROP failed, this request should be dropped.
 691          *
 692          * \see null_accept(), plain_accept(), gss_svc_accept_kr().
 693          */
 694         int                  (*accept)      (struct ptlrpc_request *req);
 695
 696         /**
 697          * Perform security transformation upon reply message.
 698          *
 699          * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
 700          * is req->rq_replen.
 701          * \post req->rs_repdata_len is the final message size.
 702          * \post req->rq_reply_off is set.
 703          *
 704          * \see null_authorize(), plain_authorize(), gss_svc_authorize().
 705          */
 706         int                  (*authorize)   (struct ptlrpc_request *req);
 707
 708         /**
 709          * Invalidate server context \a ctx.
 710          *
 711          * \see gss_svc_invalidate_ctx().
 712          */
 713         void                (*invalidate_ctx)
 714                                                (struct ptlrpc_svc_ctx *ctx);
 715
 716         /**
 717          * Allocate a ptlrpc_reply_state.
 718          *
 719          * \param msgsize size of the reply message in clear text.
 720          * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
 721          * should simply use it; otherwise we'll responsible for allocating
 722          * a new one.
 723          * \post req->rq_reply_state != NULL;
 724          * \post req->rq_reply_state->rs_msg != NULL;
 725          *
 726          * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
 727          */
 728         int                  (*alloc_rs)    (struct ptlrpc_request *req,
 729                                                 int msgsize);
 730
 731         /**
 732          * Free a ptlrpc_reply_state.
 733          */
 734         void                (*free_rs)     (struct ptlrpc_reply_state *rs);
 735
 736         /**
 737          * Release the server context \a ctx.
 738          *
 739          * \see gss_svc_free_ctx().
 740          */
 741         void                (*free_ctx)    (struct ptlrpc_svc_ctx *ctx);
 742
 743         /**
 744          * Install a reverse context based on the server context \a ctx.
 745          *
 746          * \see gss_svc_install_rctx_kr().
 747          */
 748         int                  (*install_rctx)(struct obd_import *imp,
 749                                                 struct ptlrpc_svc_ctx *ctx);
 750
 751         /**
 752          * Prepare buffer for incoming bulk write.
 753          *
 754          * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
 755          * intended to receive the write.
 756          *
 757          * \see gss_svc_prep_bulk().
 758          */
 759         int                  (*prep_bulk)   (struct ptlrpc_request *req,
 760                                                 struct ptlrpc_bulk_desc *desc);
 761
 762         /**
 763          * Unwrap the bulk write data.
 764          *
 765          * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
 766          */
 767         int                  (*unwrap_bulk) (struct ptlrpc_request *req,
 768                                                 struct ptlrpc_bulk_desc *desc);
 769
 770         /**
 771          * Wrap the bulk read data.
 772          *
 773          * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
 774          */
 775         int                  (*wrap_bulk)   (struct ptlrpc_request *req,
 776                                                 struct ptlrpc_bulk_desc *desc);
 777 };
 778
 779 struct ptlrpc_sec_policy {
 780         struct module              *sp_owner;
 781         char                       *sp_name;
 782         __u16                      sp_policy; /* policy number */
 783         struct ptlrpc_sec_cops   *sp_cops;   /* client ops */
 784         struct ptlrpc_sec_sops   *sp_sops;   /* server ops */
 785 };
 786
 787 #define PTLRPC_SEC_FL_REVERSE      0x0001 /* reverse sec */
 788 #define PTLRPC_SEC_FL_ROOTONLY    0x0002 /* treat everyone as root */
 789 #define PTLRPC_SEC_FL_UDESC          0x0004 /* ship udesc */
 790 #define PTLRPC_SEC_FL_BULK            0x0008 /* intensive bulk i/o expected */
 791 #define PTLRPC_SEC_FL_PAG              0x0010 /* PAG mode */
 792
 793 /**
 794  * The ptlrpc_sec represents the client side ptlrpc security facilities,
 795  * each obd_import (both regular and reverse import) must associate with
 796  * a ptlrpc_sec.
 797  *
 798  * \see sptlrpc_import_sec_adapt().
 799  */
 800 struct ptlrpc_sec {
 801         struct ptlrpc_sec_policy       *ps_policy;
 802         atomic_t                    ps_refcount;
 803         /** statistic only */
 804         atomic_t                    ps_nctx;
 805         /** unique identifier */
 806         int                          ps_id;
 807         struct sptlrpc_flavor      ps_flvr;
 808         enum lustre_sec_part        ps_part;
 809         /** after set, no more new context will be created */
 810         unsigned int                ps_dying:1;
 811         /** owning import */
 812         struct obd_import             *ps_import;
 813         spinlock_t                      ps_lock;
 814
 815         /*
 816          * garbage collection
 817          */
 818         struct list_head                      ps_gc_list;
 819         unsigned long                 ps_gc_interval; /* in seconds */
 820         time64_t                      ps_gc_next;     /* in seconds */
 821 };
 822
 823 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
 824 {
 825         return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
 826 }
 827
 828 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
 829 {
 830         return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
 831 }
 832
 833
 834 struct ptlrpc_svc_ctx {
 835         atomic_t                    sc_refcount;
 836         struct ptlrpc_sec_policy       *sc_policy;
 837 };
 838
 839 /*
 840  * user identity descriptor
 841  */
 842 #define LUSTRE_MAX_GROUPS              (128)
 843
 844 struct ptlrpc_user_desc {
 845         __u32      pud_uid;
 846         __u32      pud_gid;
 847         __u32      pud_fsuid;
 848         __u32      pud_fsgid;
 849         __u32      pud_cap;
 850         __u32      pud_ngroups;
 851         __u32      pud_groups[0];
 852 };
 853
 854 /*
 855  * bulk flavors
 856  */
 857 enum sptlrpc_bulk_hash_alg {
 858         BULK_HASH_ALG_NULL      = 0,
 859         BULK_HASH_ALG_ADLER32,
 860         BULK_HASH_ALG_CRC32,
 861         BULK_HASH_ALG_MD5,
 862         BULK_HASH_ALG_SHA1,
 863         BULK_HASH_ALG_SHA256,
 864         BULK_HASH_ALG_SHA384,
 865         BULK_HASH_ALG_SHA512,
 866         BULK_HASH_ALG_MAX
 867 };
 868
 869 const char *sptlrpc_get_hash_name(__u8 hash_alg);
 870 __u8 sptlrpc_get_hash_alg(const char *algname);
 871
 872 enum {
 873         BSD_FL_ERR      = 1,
 874 };
 875
 876 struct ptlrpc_bulk_sec_desc {
 877         __u8        bsd_version;    /* 0 */
 878         __u8        bsd_type;       /* SPTLRPC_BULK_XXX */
 879         __u8        bsd_svc;    /* SPTLRPC_BULK_SVC_XXXX */
 880         __u8        bsd_flags;      /* flags */
 881         __u32      bsd_nob;     /* nob of bulk data */
 882         __u8        bsd_data[0];    /* policy-specific token */
 883 };
 884
 885
 886 /*
 887  * round size up to next power of 2, for slab allocation.
 888  * @size must be sane (can't overflow after round up)
 889  */
 890 static inline int size_roundup_power2(int size)
 891 {
 892         size--;
 893         size |= size >> 1;
 894         size |= size >> 2;
 895         size |= size >> 4;
 896         size |= size >> 8;
 897         size |= size >> 16;
 898         size++;
 899         return size;
 900 }
 901
 902 /*
 903  * internal support libraries
 904  */
 905 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
 906                                   int segment, int newsize);
 907
 908 /*
 909  * security policies
 910  */
 911 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
 912 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
 913
 914 __u32 sptlrpc_name2flavor_base(const char *name);
 915 const char *sptlrpc_flavor2name_base(__u32 flvr);
 916 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
 917                                char *buf, int bufsize);
 918 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
 919 char *sptlrpc_secflags2str(__u32 flags, char *buf, int bufsize);
 920
 921 static inline
 922 struct ptlrpc_sec_policy *sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
 923 {
 924         __module_get(policy->sp_owner);
 925         return policy;
 926 }
 927
 928 static inline
 929 void sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
 930 {
 931         module_put(policy->sp_owner);
 932 }
 933
 934 /*
 935  * client credential
 936  */
 937 static inline
 938 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
 939 {
 940         return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
 941 }
 942
 943 static inline
 944 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
 945 {
 946         return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
 947 }
 948
 949 static inline
 950 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
 951 {
 952         return (cli_ctx_status(ctx) != 0);
 953 }
 954
 955 static inline
 956 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
 957 {
 958         return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
 959 }
 960
 961 static inline
 962 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
 963 {
 964         return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
 965 }
 966
 967 static inline
 968 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
 969 {
 970         return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
 971 }
 972
 973 static inline
 974 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
 975 {
 976         return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
 977 }
 978
 979 /*
 980  * sec get/put
 981  */
 982 struct ptlrpc_sec *sptlrpc_sec_get(struct ptlrpc_sec *sec);
 983 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
 984
 985 /*
 986  * internal apis which only used by policy implementation
 987  */
 988 int  sptlrpc_get_next_secid(void);
 989
 990 /*
 991  * exported client context api
 992  */
 993 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
 994 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
 995
 996 /*
 997  * exported client context wrap/buffers
 998  */
 999 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
1000 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
1001 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
1002 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
1003 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
1004 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
1005 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1006                                int segment, int newsize);
1007 int  sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1008                                     struct ptlrpc_request **req_ret);
1009 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
1010
1011 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
1012
1013 /*
1014  * exported higher interface of import & request
1015  */
1016 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1017                              struct ptlrpc_svc_ctx *ctx,
1018                              struct sptlrpc_flavor *flvr);
1019 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
1020 void sptlrpc_import_sec_put(struct obd_import *imp);
1021
1022 int  sptlrpc_import_check_ctx(struct obd_import *imp);
1023 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
1024 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
1025 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
1026 int  sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1027 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1028 int  sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1029 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1030
1031 int sptlrpc_parse_rule(char *param, struct sptlrpc_rule *rule);
1032
1033 /* gc */
1034 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1035 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1036
1037 /* misc */
1038 const char *sec2target_str(struct ptlrpc_sec *sec);
1039 /*
1040  * lprocfs
1041  */
1042 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *dev);
1043
1044 /*
1045  * server side
1046  */
1047 enum secsvc_accept_res {
1048         SECSVC_OK       = 0,
1049         SECSVC_COMPLETE,
1050         SECSVC_DROP,
1051 };
1052
1053 int  sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1054 int  sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1055 int  sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1056 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1057 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1058 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1059
1060 int  sptlrpc_target_export_check(struct obd_export *exp,
1061                                  struct ptlrpc_request *req);
1062 /*
1063  * reverse context
1064  */
1065 int sptlrpc_svc_install_rvs_ctx(struct obd_import *imp,
1066                                 struct ptlrpc_svc_ctx *ctx);
1067
1068 /* bulk security api */
1069 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1070
1071 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1072                           struct ptlrpc_bulk_desc *desc);
1073 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1074                                  struct ptlrpc_bulk_desc *desc,
1075                                  int nob);
1076 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1077                                   struct ptlrpc_bulk_desc *desc);
1078
1079 /* bulk helpers (internal use only by policies) */
1080 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1081                               void *buf, int buflen);
1082
1083 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1084
1085 /* user descriptor helpers */
1086 static inline int sptlrpc_user_desc_size(int ngroups)
1087 {
1088         return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1089 }
1090
1091 int sptlrpc_current_user_desc_size(void);
1092 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1093 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1094
1095
1096 #define CFS_CAP_CHOWN_MASK (1 << CFS_CAP_CHOWN)
1097 #define CFS_CAP_SYS_RESOURCE_MASK (1 << CFS_CAP_SYS_RESOURCE)
1098
1099 enum {
1100         LUSTRE_SEC_NONE  = 0,
1101         LUSTRE_SEC_REMOTE       = 1,
1102         LUSTRE_SEC_SPECIFY      = 2,
1103         LUSTRE_SEC_ALL    = 3
1104 };
1105
1106 /** @} sptlrpc */
1107
1108 #endif /* _LUSTRE_SEC_H_ */