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 bool 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 struct vfs_cred {
 346         uint32_t        vc_uid;
 347         uint32_t        vc_gid;
 348 };
 349
 350 struct ptlrpc_ctx_ops {
 351         /**
 352          * To determine whether it's suitable to use the \a ctx for \a vcred.
 353          */
 354         int (*match)(struct ptlrpc_cli_ctx *ctx, struct vfs_cred *vcred);
 355
 356         /**
 357          * To bring the \a ctx uptodate.
 358          */
 359         int (*refresh)(struct ptlrpc_cli_ctx *ctx);
 360
 361         /**
 362          * Validate the \a ctx.
 363          */
 364         int (*validate)(struct ptlrpc_cli_ctx *ctx);
 365
 366         /**
 367          * Force the \a ctx to die.
 368          */
 369         void (*force_die)(struct ptlrpc_cli_ctx *ctx, int grace);
 370         int (*display)(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
 371
 372         /**
 373          * Sign the request message using \a ctx.
 374          *
 375          * \pre req->rq_reqmsg point to request message.
 376          * \pre req->rq_reqlen is the request message length.
 377          * \post req->rq_reqbuf point to request message with signature.
 378          * \post req->rq_reqdata_len is set to the final request message size.
 379          *
 380          * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
 381          */
 382         int (*sign)(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
 383
 384         /**
 385          * Verify the reply message using \a ctx.
 386          *
 387          * \pre req->rq_repdata point to reply message with signature.
 388          * \pre req->rq_repdata_len is the total reply message length.
 389          * \post req->rq_repmsg point to reply message without signature.
 390          * \post req->rq_replen is the reply message length.
 391          *
 392          * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
 393          */
 394         int (*verify)(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
 395
 396         /**
 397          * Encrypt the request message using \a ctx.
 398          *
 399          * \pre req->rq_reqmsg point to request message in clear text.
 400          * \pre req->rq_reqlen is the request message length.
 401          * \post req->rq_reqbuf point to request message.
 402          * \post req->rq_reqdata_len is set to the final request message size.
 403          *
 404          * \see gss_cli_ctx_seal().
 405          */
 406         int (*seal)(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
 407
 408         /**
 409          * Decrypt the reply message using \a ctx.
 410          *
 411          * \pre req->rq_repdata point to encrypted reply message.
 412          * \pre req->rq_repdata_len is the total cipher text length.
 413          * \post req->rq_repmsg point to reply message in clear text.
 414          * \post req->rq_replen is the reply message length in clear text.
 415          *
 416          * \see gss_cli_ctx_unseal().
 417          */
 418         int (*unseal)(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req);
 419
 420         /**
 421          * Wrap bulk request data. This is called before wrapping RPC
 422          * request message.
 423          *
 424          * \pre bulk buffer is descripted by desc->bd_iov and
 425          * desc->bd_iov_count. note for read it's just buffer, no data
 426          * need to be sent;  for write it contains data in clear text.
 427          * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
 428          * (usually inside of RPC request message).
 429          * - encryption: cipher text bulk buffer is descripted by
 430          *   desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
 431          *   count remains the same).
 432          * - otherwise: bulk buffer is still desc->bd_iov and
 433          *   desc->bd_iov_count.
 434          *
 435          * \return 0: success.
 436          * \return -ev: error code.
 437          *
 438          * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
 439          */
 440         int (*wrap_bulk)(struct ptlrpc_cli_ctx *ctx,
 441                          struct ptlrpc_request *req,
 442                          struct ptlrpc_bulk_desc *desc);
 443
 444         /**
 445          * Unwrap bulk reply data. This is called after wrapping RPC
 446          * reply message.
 447          *
 448          * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
 449          * desc->bd_iov_count, according to wrap_bulk().
 450          * \post final bulk data in clear text is placed in buffer described
 451          * by desc->bd_iov and desc->bd_iov_count.
 452          * \return +ve nob of actual bulk data in clear text.
 453          * \return -ve error code.
 454          *
 455          * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
 456          */
 457         int (*unwrap_bulk)(struct ptlrpc_cli_ctx *ctx,
 458                            struct ptlrpc_request *req,
 459                            struct ptlrpc_bulk_desc *desc);
 460 };
 461
 462 #define PTLRPC_CTX_NEW_BIT           (0)  /* newly created */
 463 #define PTLRPC_CTX_UPTODATE_BIT (1)  /* uptodate */
 464 #define PTLRPC_CTX_DEAD_BIT         (2)  /* mark expired gracefully */
 465 #define PTLRPC_CTX_ERROR_BIT       (3)  /* fatal error (refresh, etc.) */
 466 #define PTLRPC_CTX_CACHED_BIT     (8)  /* in ctx cache (hash etc.) */
 467 #define PTLRPC_CTX_ETERNAL_BIT   (9)  /* always valid */
 468
 469 #define PTLRPC_CTX_NEW           (1 << PTLRPC_CTX_NEW_BIT)
 470 #define PTLRPC_CTX_UPTODATE         (1 << PTLRPC_CTX_UPTODATE_BIT)
 471 #define PTLRPC_CTX_DEAD         (1 << PTLRPC_CTX_DEAD_BIT)
 472 #define PTLRPC_CTX_ERROR               (1 << PTLRPC_CTX_ERROR_BIT)
 473 #define PTLRPC_CTX_CACHED             (1 << PTLRPC_CTX_CACHED_BIT)
 474 #define PTLRPC_CTX_ETERNAL           (1 << PTLRPC_CTX_ETERNAL_BIT)
 475
 476 #define PTLRPC_CTX_STATUS_MASK   (PTLRPC_CTX_NEW_BIT    |       \
 477                                         PTLRPC_CTX_UPTODATE   |       \
 478                                         PTLRPC_CTX_DEAD       |       \
 479                                         PTLRPC_CTX_ERROR)
 480
 481 struct ptlrpc_cli_ctx {
 482         struct hlist_node       cc_cache;      /* linked into ctx cache */
 483         atomic_t            cc_refcount;
 484         struct ptlrpc_sec      *cc_sec;
 485         struct ptlrpc_ctx_ops  *cc_ops;
 486         unsigned long         cc_expire;     /* in seconds */
 487         unsigned int        cc_early_expire:1;
 488         unsigned long      cc_flags;
 489         struct vfs_cred  cc_vcred;
 490         spinlock_t              cc_lock;
 491         struct list_head              cc_req_list;   /* waiting reqs linked here */
 492         struct list_head              cc_gc_chain;   /* linked to gc chain */
 493 };
 494
 495 /**
 496  * client side policy operation vector.
 497  */
 498 struct ptlrpc_sec_cops {
 499         /**
 500          * Given an \a imp, create and initialize a ptlrpc_sec structure.
 501          * \param ctx service context:
 502          * - regular import: \a ctx should be NULL;
 503          * - reverse import: \a ctx is obtained from incoming request.
 504          * \param flavor specify what flavor to use.
 505          *
 506          * When necessary, policy module is responsible for taking reference
 507          * on the import.
 508          *
 509          * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
 510          */
 511         struct ptlrpc_sec *(*create_sec)(struct obd_import *imp,
 512                                          struct ptlrpc_svc_ctx *ctx,
 513                                          struct sptlrpc_flavor *flavor);
 514
 515         /**
 516          * Destructor of ptlrpc_sec. When called, refcount has been dropped
 517          * to 0 and all contexts has been destroyed.
 518          *
 519          * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
 520          */
 521         void (*destroy_sec)(struct ptlrpc_sec *sec);
 522
 523         /**
 524          * Notify that this ptlrpc_sec is going to die. Optionally, policy
 525          * module is supposed to set sec->ps_dying and whatever necessary
 526          * actions.
 527          *
 528          * \see plain_kill_sec(), gss_sec_kill().
 529          */
 530         void (*kill_sec)(struct ptlrpc_sec *sec);
 531
 532         /**
 533          * Given \a vcred, lookup and/or create its context. The policy module
 534          * is supposed to maintain its own context cache.
 535          * XXX currently \a create and \a remove_dead is always 1, perhaps
 536          * should be removed completely.
 537          *
 538          * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
 539          */
 540         struct ptlrpc_cli_ctx *(*lookup_ctx)(struct ptlrpc_sec *sec,
 541                                              struct vfs_cred *vcred,
 542                                              int create, int remove_dead);
 543
 544         /**
 545          * Called then the reference of \a ctx dropped to 0. The policy module
 546          * is supposed to destroy this context or whatever else according to
 547          * its cache maintenance mechanism.
 548          *
 549          * \param sync if zero, we shouldn't wait for the context being
 550          * destroyed completely.
 551          *
 552          * \see plain_release_ctx(), gss_sec_release_ctx_kr().
 553          */
 554         void (*release_ctx)(struct ptlrpc_sec *sec, struct ptlrpc_cli_ctx *ctx,
 555                             int sync);
 556
 557         /**
 558          * Flush the context cache.
 559          *
 560          * \param uid context of which user, -1 means all contexts.
 561          * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
 562          * contexts should be cleared immediately.
 563          * \param force if zero, only idle contexts will be flushed.
 564          *
 565          * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
 566          */
 567         int (*flush_ctx_cache)(struct ptlrpc_sec *sec, uid_t uid,
 568                                int grace, int force);
 569
 570         /**
 571          * Called periodically by garbage collector to remove dead contexts
 572          * from cache.
 573          *
 574          * \see gss_sec_gc_ctx_kr().
 575          */
 576         void (*gc_ctx)(struct ptlrpc_sec *sec);
 577
 578         /**
 579          * Given an context \a ctx, install a corresponding reverse service
 580          * context on client side.
 581          * XXX currently it's only used by GSS module, maybe we should remove
 582          * this from general API.
 583          */
 584         int (*install_rctx)(struct obd_import *imp, struct ptlrpc_sec *sec,
 585                             struct ptlrpc_cli_ctx *ctx);
 586
 587         /**
 588          * To allocate request buffer for \a req.
 589          *
 590          * \pre req->rq_reqmsg == NULL.
 591          * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
 592          * we are not supposed to free it.
 593          * \post if success, req->rq_reqmsg point to a buffer with size
 594          * at least \a lustre_msg_size.
 595          *
 596          * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
 597          */
 598         int (*alloc_reqbuf)(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
 599                             int lustre_msg_size);
 600
 601         /**
 602          * To free request buffer for \a req.
 603          *
 604          * \pre req->rq_reqbuf != NULL.
 605          *
 606          * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
 607          */
 608         void (*free_reqbuf)(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
 609
 610         /**
 611          * To allocate reply buffer for \a req.
 612          *
 613          * \pre req->rq_repbuf == NULL.
 614          * \post if success, req->rq_repbuf point to a buffer with size
 615          * req->rq_repbuf_len, the size should be large enough to receive
 616          * reply which be transformed from \a lustre_msg_size of clear text.
 617          *
 618          * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
 619          */
 620         int (*alloc_repbuf)(struct ptlrpc_sec *sec, struct ptlrpc_request *req,
 621                             int lustre_msg_size);
 622
 623         /**
 624          * To free reply buffer for \a req.
 625          *
 626          * \pre req->rq_repbuf != NULL.
 627          * \post req->rq_repbuf == NULL.
 628          * \post req->rq_repbuf_len == 0.
 629          *
 630          * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
 631          */
 632         void (*free_repbuf)(struct ptlrpc_sec *sec, struct ptlrpc_request *req);
 633
 634         /**
 635          * To expand the request buffer of \a req, thus the \a segment in
 636          * the request message pointed by req->rq_reqmsg can accommodate
 637          * at least \a newsize of data.
 638          *
 639          * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
 640          *
 641          * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
 642          * gss_enlarge_reqbuf().
 643          */
 644         int (*enlarge_reqbuf)(struct ptlrpc_sec *sec,
 645                               struct ptlrpc_request *req,
 646                               int segment, int newsize);
 647         /*
 648          * misc
 649          */
 650         int (*display)(struct ptlrpc_sec *sec, struct seq_file *seq);
 651 };
 652
 653 /**
 654  * server side policy operation vector.
 655  */
 656 struct ptlrpc_sec_sops {
 657         /**
 658          * verify an incoming request.
 659          *
 660          * \pre request message is pointed by req->rq_reqbuf, size is
 661          * req->rq_reqdata_len; and the message has been unpacked to
 662          * host byte order.
 663          *
 664          * \retval SECSVC_OK success, req->rq_reqmsg point to request message
 665          * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
 666          * req->rq_sp_from is decoded from request.
 667          * \retval SECSVC_COMPLETE success, the request has been fully
 668          * processed, and reply message has been prepared; req->rq_sp_from is
 669          * decoded from request.
 670          * \retval SECSVC_DROP failed, this request should be dropped.
 671          *
 672          * \see null_accept(), plain_accept(), gss_svc_accept_kr().
 673          */
 674         int (*accept)(struct ptlrpc_request *req);
 675
 676         /**
 677          * Perform security transformation upon reply message.
 678          *
 679          * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
 680          * is req->rq_replen.
 681          * \post req->rs_repdata_len is the final message size.
 682          * \post req->rq_reply_off is set.
 683          *
 684          * \see null_authorize(), plain_authorize(), gss_svc_authorize().
 685          */
 686         int (*authorize)(struct ptlrpc_request *req);
 687
 688         /**
 689          * Invalidate server context \a ctx.
 690          *
 691          * \see gss_svc_invalidate_ctx().
 692          */
 693         void (*invalidate_ctx)(struct ptlrpc_svc_ctx *ctx);
 694
 695         /**
 696          * Allocate a ptlrpc_reply_state.
 697          *
 698          * \param msgsize size of the reply message in clear text.
 699          * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
 700          * should simply use it; otherwise we'll responsible for allocating
 701          * a new one.
 702          * \post req->rq_reply_state != NULL;
 703          * \post req->rq_reply_state->rs_msg != NULL;
 704          *
 705          * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
 706          */
 707         int (*alloc_rs)(struct ptlrpc_request *req, int msgsize);
 708
 709         /**
 710          * Free a ptlrpc_reply_state.
 711          */
 712         void (*free_rs)(struct ptlrpc_reply_state *rs);
 713
 714         /**
 715          * Release the server context \a ctx.
 716          *
 717          * \see gss_svc_free_ctx().
 718          */
 719         void (*free_ctx)(struct ptlrpc_svc_ctx *ctx);
 720
 721         /**
 722          * Install a reverse context based on the server context \a ctx.
 723          *
 724          * \see gss_svc_install_rctx_kr().
 725          */
 726         int (*install_rctx)(struct obd_import *imp, struct ptlrpc_svc_ctx *ctx);
 727
 728         /**
 729          * Prepare buffer for incoming bulk write.
 730          *
 731          * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
 732          * intended to receive the write.
 733          *
 734          * \see gss_svc_prep_bulk().
 735          */
 736         int (*prep_bulk)(struct ptlrpc_request *req,
 737                          struct ptlrpc_bulk_desc *desc);
 738
 739         /**
 740          * Unwrap the bulk write data.
 741          *
 742          * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
 743          */
 744         int (*unwrap_bulk)(struct ptlrpc_request *req,
 745                            struct ptlrpc_bulk_desc *desc);
 746
 747         /**
 748          * Wrap the bulk read data.
 749          *
 750          * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
 751          */
 752         int (*wrap_bulk)(struct ptlrpc_request *req,
 753                          struct ptlrpc_bulk_desc *desc);
 754 };
 755
 756 struct ptlrpc_sec_policy {
 757         struct module              *sp_owner;
 758         char                       *sp_name;
 759         __u16                      sp_policy; /* policy number */
 760         struct ptlrpc_sec_cops   *sp_cops;   /* client ops */
 761         struct ptlrpc_sec_sops   *sp_sops;   /* server ops */
 762 };
 763
 764 #define PTLRPC_SEC_FL_REVERSE      0x0001 /* reverse sec */
 765 #define PTLRPC_SEC_FL_ROOTONLY    0x0002 /* treat everyone as root */
 766 #define PTLRPC_SEC_FL_UDESC          0x0004 /* ship udesc */
 767 #define PTLRPC_SEC_FL_BULK            0x0008 /* intensive bulk i/o expected */
 768 #define PTLRPC_SEC_FL_PAG              0x0010 /* PAG mode */
 769
 770 /**
 771  * The ptlrpc_sec represents the client side ptlrpc security facilities,
 772  * each obd_import (both regular and reverse import) must associate with
 773  * a ptlrpc_sec.
 774  *
 775  * \see sptlrpc_import_sec_adapt().
 776  */
 777 struct ptlrpc_sec {
 778         struct ptlrpc_sec_policy       *ps_policy;
 779         atomic_t                    ps_refcount;
 780         /** statistic only */
 781         atomic_t                    ps_nctx;
 782         /** unique identifier */
 783         int                          ps_id;
 784         struct sptlrpc_flavor      ps_flvr;
 785         enum lustre_sec_part        ps_part;
 786         /** after set, no more new context will be created */
 787         unsigned int                ps_dying:1;
 788         /** owning import */
 789         struct obd_import             *ps_import;
 790         spinlock_t                      ps_lock;
 791
 792         /*
 793          * garbage collection
 794          */
 795         struct list_head                      ps_gc_list;
 796         unsigned long                 ps_gc_interval; /* in seconds */
 797         time64_t                      ps_gc_next;     /* in seconds */
 798 };
 799
 800 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
 801 {
 802         return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
 803 }
 804
 805 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
 806 {
 807         return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
 808 }
 809
 810 struct ptlrpc_svc_ctx {
 811         atomic_t                    sc_refcount;
 812         struct ptlrpc_sec_policy       *sc_policy;
 813 };
 814
 815 /*
 816  * user identity descriptor
 817  */
 818 #define LUSTRE_MAX_GROUPS              (128)
 819
 820 struct ptlrpc_user_desc {
 821         __u32      pud_uid;
 822         __u32      pud_gid;
 823         __u32      pud_fsuid;
 824         __u32      pud_fsgid;
 825         __u32      pud_cap;
 826         __u32      pud_ngroups;
 827         __u32      pud_groups[0];
 828 };
 829
 830 /*
 831  * bulk flavors
 832  */
 833 enum sptlrpc_bulk_hash_alg {
 834         BULK_HASH_ALG_NULL      = 0,
 835         BULK_HASH_ALG_ADLER32,
 836         BULK_HASH_ALG_CRC32,
 837         BULK_HASH_ALG_MD5,
 838         BULK_HASH_ALG_SHA1,
 839         BULK_HASH_ALG_SHA256,
 840         BULK_HASH_ALG_SHA384,
 841         BULK_HASH_ALG_SHA512,
 842         BULK_HASH_ALG_MAX
 843 };
 844
 845 const char *sptlrpc_get_hash_name(__u8 hash_alg);
 846 __u8 sptlrpc_get_hash_alg(const char *algname);
 847
 848 enum {
 849         BSD_FL_ERR      = 1,
 850 };
 851
 852 struct ptlrpc_bulk_sec_desc {
 853         __u8        bsd_version;    /* 0 */
 854         __u8        bsd_type;       /* SPTLRPC_BULK_XXX */
 855         __u8        bsd_svc;    /* SPTLRPC_BULK_SVC_XXXX */
 856         __u8        bsd_flags;      /* flags */
 857         __u32      bsd_nob;     /* nob of bulk data */
 858         __u8        bsd_data[0];    /* policy-specific token */
 859 };
 860
 861 /*
 862  * round size up to next power of 2, for slab allocation.
 863  * @size must be sane (can't overflow after round up)
 864  */
 865 static inline int size_roundup_power2(int size)
 866 {
 867         size--;
 868         size |= size >> 1;
 869         size |= size >> 2;
 870         size |= size >> 4;
 871         size |= size >> 8;
 872         size |= size >> 16;
 873         size++;
 874         return size;
 875 }
 876
 877 /*
 878  * internal support libraries
 879  */
 880 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
 881                                   int segment, int newsize);
 882
 883 /*
 884  * security policies
 885  */
 886 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
 887 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
 888
 889 __u32 sptlrpc_name2flavor_base(const char *name);
 890 const char *sptlrpc_flavor2name_base(__u32 flvr);
 891 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
 892                                char *buf, int bufsize);
 893 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
 894
 895 static inline
 896 struct ptlrpc_sec_policy *sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
 897 {
 898         __module_get(policy->sp_owner);
 899         return policy;
 900 }
 901
 902 static inline
 903 void sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
 904 {
 905         module_put(policy->sp_owner);
 906 }
 907
 908 /*
 909  * client credential
 910  */
 911 static inline
 912 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
 913 {
 914         return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
 915 }
 916
 917 static inline
 918 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
 919 {
 920         return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
 921 }
 922
 923 static inline
 924 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
 925 {
 926         return (cli_ctx_status(ctx) != 0);
 927 }
 928
 929 static inline
 930 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
 931 {
 932         return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
 933 }
 934
 935 static inline
 936 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
 937 {
 938         return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
 939 }
 940
 941 static inline
 942 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
 943 {
 944         return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
 945 }
 946
 947 static inline
 948 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
 949 {
 950         return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
 951 }
 952
 953 /*
 954  * sec get/put
 955  */
 956 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
 957
 958 /*
 959  * internal apis which only used by policy implementation
 960  */
 961 int  sptlrpc_get_next_secid(void);
 962
 963 /*
 964  * exported client context api
 965  */
 966 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
 967 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
 968
 969 /*
 970  * exported client context wrap/buffers
 971  */
 972 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
 973 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
 974 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
 975 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
 976 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
 977 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
 978 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
 979                                int segment, int newsize);
 980 int  sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
 981                                     struct ptlrpc_request **req_ret);
 982 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
 983
 984 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
 985
 986 /*
 987  * exported higher interface of import & request
 988  */
 989 int sptlrpc_import_sec_adapt(struct obd_import *imp,
 990                              struct ptlrpc_svc_ctx *ctx,
 991                              struct sptlrpc_flavor *flvr);
 992 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
 993 void sptlrpc_import_sec_put(struct obd_import *imp);
 994
 995 int  sptlrpc_import_check_ctx(struct obd_import *imp);
 996 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
 997 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
 998 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
 999 int  sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1000 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1001 int  sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1002 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1003
1004 /* gc */
1005 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1006 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1007
1008 /* misc */
1009 const char *sec2target_str(struct ptlrpc_sec *sec);
1010 /*
1011  * lprocfs
1012  */
1013 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *dev);
1014
1015 /*
1016  * server side
1017  */
1018 enum secsvc_accept_res {
1019         SECSVC_OK       = 0,
1020         SECSVC_COMPLETE,
1021         SECSVC_DROP,
1022 };
1023
1024 int  sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1025 int  sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1026 int  sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1027 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1028 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1029 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1030
1031 int  sptlrpc_target_export_check(struct obd_export *exp,
1032                                  struct ptlrpc_request *req);
1033
1034 /* bulk security api */
1035 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1036
1037 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1038                           struct ptlrpc_bulk_desc *desc);
1039 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1040                                  struct ptlrpc_bulk_desc *desc,
1041                                  int nob);
1042 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1043                                   struct ptlrpc_bulk_desc *desc);
1044
1045 /* bulk helpers (internal use only by policies) */
1046 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1047                               void *buf, int buflen);
1048
1049 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1050
1051 /* user descriptor helpers */
1052 static inline int sptlrpc_user_desc_size(int ngroups)
1053 {
1054         return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1055 }
1056
1057 int sptlrpc_current_user_desc_size(void);
1058 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1059 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1060
1061 #define CFS_CAP_CHOWN_MASK (1 << CFS_CAP_CHOWN)
1062 #define CFS_CAP_SYS_RESOURCE_MASK (1 << CFS_CAP_SYS_RESOURCE)
1063
1064 enum {
1065         LUSTRE_SEC_NONE  = 0,
1066         LUSTRE_SEC_REMOTE       = 1,
1067         LUSTRE_SEC_SPECIFY      = 2,
1068         LUSTRE_SEC_ALL    = 3
1069 };
1070
1071 /** @} sptlrpc */
1072
1073 #endif /* _LUSTRE_SEC_H_ */