4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #ifndef _LUSTRE_SEC_H_
33 #define _LUSTRE_SEC_H_
35 /** \defgroup sptlrpc sptlrpc
45 struct ptlrpc_request;
46 struct ptlrpc_reply_state;
47 struct ptlrpc_bulk_desc;
58 struct ptlrpc_sec_policy;
59 struct ptlrpc_sec_cops;
60 struct ptlrpc_sec_sops;
62 struct ptlrpc_svc_ctx;
63 struct ptlrpc_cli_ctx;
64 struct ptlrpc_ctx_ops;
68 * \addtogroup flavor flavor
70 * RPC flavor is represented by a 32 bits integer. Currently the high 12 bits
71 * are unused, must be set to 0 for future expansion.
73 * ------------------------------------------------------------------------
74 * | 4b (bulk svc) | 4b (bulk type) | 4b (svc) | 4b (mech) | 4b (policy) |
75 * ------------------------------------------------------------------------
85 SPTLRPC_POLICY_NULL = 0,
86 SPTLRPC_POLICY_PLAIN = 1,
87 SPTLRPC_POLICY_GSS = 2,
91 enum sptlrpc_mech_null {
92 SPTLRPC_MECH_NULL = 0,
93 SPTLRPC_MECH_NULL_MAX,
96 enum sptlrpc_mech_plain {
97 SPTLRPC_MECH_PLAIN = 0,
98 SPTLRPC_MECH_PLAIN_MAX,
101 enum sptlrpc_mech_gss {
102 SPTLRPC_MECH_GSS_NULL = 0,
103 SPTLRPC_MECH_GSS_KRB5 = 1,
104 SPTLRPC_MECH_GSS_SK = 2,
105 SPTLRPC_MECH_GSS_MAX,
108 enum sptlrpc_service_type {
109 SPTLRPC_SVC_NULL = 0, /**< no security */
110 SPTLRPC_SVC_AUTH = 1, /**< authentication only */
111 SPTLRPC_SVC_INTG = 2, /**< integrity */
112 SPTLRPC_SVC_PRIV = 3, /**< privacy */
116 enum sptlrpc_bulk_type {
117 SPTLRPC_BULK_DEFAULT = 0, /**< follow rpc flavor */
118 SPTLRPC_BULK_HASH = 1, /**< hash integrity */
122 enum sptlrpc_bulk_service {
123 SPTLRPC_BULK_SVC_NULL = 0, /**< no security */
124 SPTLRPC_BULK_SVC_AUTH = 1, /**< authentication only */
125 SPTLRPC_BULK_SVC_INTG = 2, /**< integrity */
126 SPTLRPC_BULK_SVC_PRIV = 3, /**< privacy */
127 SPTLRPC_BULK_SVC_MAX,
131 * compose/extract macros
133 #define FLVR_POLICY_OFFSET (0)
134 #define FLVR_MECH_OFFSET (4)
135 #define FLVR_SVC_OFFSET (8)
136 #define FLVR_BULK_TYPE_OFFSET (12)
137 #define FLVR_BULK_SVC_OFFSET (16)
139 #define MAKE_FLVR(policy, mech, svc, btype, bsvc) \
140 (((__u32)(policy) << FLVR_POLICY_OFFSET) | \
141 ((__u32)(mech) << FLVR_MECH_OFFSET) | \
142 ((__u32)(svc) << FLVR_SVC_OFFSET) | \
143 ((__u32)(btype) << FLVR_BULK_TYPE_OFFSET) | \
144 ((__u32)(bsvc) << FLVR_BULK_SVC_OFFSET))
149 #define SPTLRPC_FLVR_POLICY(flavor) \
150 ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xF)
151 #define SPTLRPC_FLVR_MECH(flavor) \
152 ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xF)
153 #define SPTLRPC_FLVR_SVC(flavor) \
154 ((((__u32)(flavor)) >> FLVR_SVC_OFFSET) & 0xF)
155 #define SPTLRPC_FLVR_BULK_TYPE(flavor) \
156 ((((__u32)(flavor)) >> FLVR_BULK_TYPE_OFFSET) & 0xF)
157 #define SPTLRPC_FLVR_BULK_SVC(flavor) \
158 ((((__u32)(flavor)) >> FLVR_BULK_SVC_OFFSET) & 0xF)
160 #define SPTLRPC_FLVR_BASE(flavor) \
161 ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xFFF)
162 #define SPTLRPC_FLVR_BASE_SUB(flavor) \
163 ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xFF)
168 #define MAKE_BASE_SUBFLVR(mech, svc) \
170 ((__u32)(svc) << (FLVR_SVC_OFFSET - FLVR_MECH_OFFSET)))
172 #define SPTLRPC_SUBFLVR_GSSNULL \
173 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_NULL, SPTLRPC_SVC_NULL)
174 #define SPTLRPC_SUBFLVR_KRB5N \
175 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_NULL)
176 #define SPTLRPC_SUBFLVR_KRB5A \
177 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_AUTH)
178 #define SPTLRPC_SUBFLVR_KRB5I \
179 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_INTG)
180 #define SPTLRPC_SUBFLVR_KRB5P \
181 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_PRIV)
182 #define SPTLRPC_SUBFLVR_SKN \
183 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_SK, SPTLRPC_SVC_NULL)
184 #define SPTLRPC_SUBFLVR_SKA \
185 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_SK, SPTLRPC_SVC_AUTH)
186 #define SPTLRPC_SUBFLVR_SKI \
187 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_SK, SPTLRPC_SVC_INTG)
188 #define SPTLRPC_SUBFLVR_SKPI \
189 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_SK, SPTLRPC_SVC_PRIV)
194 #define SPTLRPC_FLVR_NULL \
195 MAKE_FLVR(SPTLRPC_POLICY_NULL, \
198 SPTLRPC_BULK_DEFAULT, \
199 SPTLRPC_BULK_SVC_NULL)
200 #define SPTLRPC_FLVR_PLAIN \
201 MAKE_FLVR(SPTLRPC_POLICY_PLAIN, \
202 SPTLRPC_MECH_PLAIN, \
205 SPTLRPC_BULK_SVC_INTG)
206 #define SPTLRPC_FLVR_GSSNULL \
207 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
208 SPTLRPC_MECH_GSS_NULL, \
210 SPTLRPC_BULK_DEFAULT, \
211 SPTLRPC_BULK_SVC_NULL)
212 #define SPTLRPC_FLVR_KRB5N \
213 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
214 SPTLRPC_MECH_GSS_KRB5, \
216 SPTLRPC_BULK_DEFAULT, \
217 SPTLRPC_BULK_SVC_NULL)
218 #define SPTLRPC_FLVR_KRB5A \
219 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
220 SPTLRPC_MECH_GSS_KRB5, \
222 SPTLRPC_BULK_DEFAULT, \
223 SPTLRPC_BULK_SVC_NULL)
224 #define SPTLRPC_FLVR_KRB5I \
225 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
226 SPTLRPC_MECH_GSS_KRB5, \
228 SPTLRPC_BULK_DEFAULT, \
229 SPTLRPC_BULK_SVC_INTG)
230 #define SPTLRPC_FLVR_KRB5P \
231 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
232 SPTLRPC_MECH_GSS_KRB5, \
234 SPTLRPC_BULK_DEFAULT, \
235 SPTLRPC_BULK_SVC_PRIV)
236 #define SPTLRPC_FLVR_SKN \
237 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
238 SPTLRPC_MECH_GSS_SK, \
240 SPTLRPC_BULK_DEFAULT, \
241 SPTLRPC_BULK_SVC_NULL)
242 #define SPTLRPC_FLVR_SKA \
243 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
244 SPTLRPC_MECH_GSS_SK, \
246 SPTLRPC_BULK_DEFAULT, \
247 SPTLRPC_BULK_SVC_NULL)
248 #define SPTLRPC_FLVR_SKI \
249 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
250 SPTLRPC_MECH_GSS_SK, \
252 SPTLRPC_BULK_DEFAULT, \
253 SPTLRPC_BULK_SVC_INTG)
254 #define SPTLRPC_FLVR_SKPI \
255 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
256 SPTLRPC_MECH_GSS_SK, \
258 SPTLRPC_BULK_DEFAULT, \
259 SPTLRPC_BULK_SVC_PRIV)
261 #define SPTLRPC_FLVR_DEFAULT SPTLRPC_FLVR_NULL
263 #define SPTLRPC_FLVR_INVALID ((__u32) 0xFFFFFFFF)
264 #define SPTLRPC_FLVR_ANY ((__u32) 0xFFF00000)
267 * extract the useful part from wire flavor
269 #define WIRE_FLVR(wflvr) (((__u32) (wflvr)) & 0x000FFFFF)
273 static inline void flvr_set_svc(__u32 *flvr, __u32 svc)
275 LASSERT(svc < SPTLRPC_SVC_MAX);
276 *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
277 SPTLRPC_FLVR_MECH(*flvr),
279 SPTLRPC_FLVR_BULK_TYPE(*flvr),
280 SPTLRPC_FLVR_BULK_SVC(*flvr));
283 static inline void flvr_set_bulk_svc(__u32 *flvr, __u32 svc)
285 LASSERT(svc < SPTLRPC_BULK_SVC_MAX);
286 *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
287 SPTLRPC_FLVR_MECH(*flvr),
288 SPTLRPC_FLVR_SVC(*flvr),
289 SPTLRPC_FLVR_BULK_TYPE(*flvr),
293 struct bulk_spec_hash {
298 * Full description of flavors being used on a ptlrpc connection, include
299 * both regular RPC and bulk transfer parts.
301 struct sptlrpc_flavor {
303 * wire flavor, should be renamed to sf_wire.
307 * general flags of PTLRPC_SEC_FL_*
311 * rpc flavor specification
314 /* nothing for now */
317 * bulk flavor specification
320 struct bulk_spec_hash hash;
325 * identify the RPC is generated from what part of Lustre. It's encoded into
326 * RPC requests and to be checked by ptlrpc service.
328 enum lustre_sec_part {
337 const char *sptlrpc_part2name(enum lustre_sec_part sp);
338 enum lustre_sec_part sptlrpc_target_sec_part(struct obd_device *obd);
341 * A rule specifies a flavor to be used by a ptlrpc connection between
344 struct sptlrpc_rule {
345 __u32 sr_netid; /* LNET network ID */
346 __u8 sr_from; /* sec_part */
347 __u8 sr_to; /* sec_part */
349 struct sptlrpc_flavor sr_flvr;
353 * A set of rules in memory.
355 * Rules are generated and stored on MGS, and propagated to MDT, OST,
356 * and client when needed.
358 struct sptlrpc_rule_set {
361 struct sptlrpc_rule *srs_rules;
364 int sptlrpc_parse_flavor(const char *str, struct sptlrpc_flavor *flvr);
365 int sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr);
367 static inline void sptlrpc_rule_set_init(struct sptlrpc_rule_set *set)
369 memset(set, 0, sizeof(*set));
372 void sptlrpc_rule_set_free(struct sptlrpc_rule_set *set);
373 int sptlrpc_rule_set_expand(struct sptlrpc_rule_set *set);
374 int sptlrpc_rule_set_merge(struct sptlrpc_rule_set *set,
375 struct sptlrpc_rule *rule);
376 int sptlrpc_rule_set_choose(struct sptlrpc_rule_set *rset,
377 enum lustre_sec_part from,
378 enum lustre_sec_part to,
380 struct sptlrpc_flavor *sf);
381 void sptlrpc_rule_set_dump(struct sptlrpc_rule_set *set);
383 int sptlrpc_process_config(struct lustre_cfg *lcfg);
384 void sptlrpc_conf_log_start(const char *logname);
385 void sptlrpc_conf_log_stop(const char *logname);
386 void sptlrpc_conf_log_update_begin(const char *logname);
387 void sptlrpc_conf_log_update_end(const char *logname);
388 void sptlrpc_conf_client_adapt(struct obd_device *obd);
389 int sptlrpc_conf_target_get_rules(struct obd_device *obd,
390 struct sptlrpc_rule_set *rset);
391 void sptlrpc_target_choose_flavor(struct sptlrpc_rule_set *rset,
392 enum lustre_sec_part from,
394 struct sptlrpc_flavor *flavor);
396 /* The maximum length of security payload. 1024 is enough for Kerberos 5,
397 * and should be enough for other future mechanisms but not sure.
398 * Only used by pre-allocated request/reply pool.
400 #define SPTLRPC_MAX_PAYLOAD (1024)
408 struct ptlrpc_ctx_ops {
410 * To determine whether it's suitable to use the \a ctx for \a vcred.
412 int (*match) (struct ptlrpc_cli_ctx *ctx,
413 struct vfs_cred *vcred);
416 * To bring the \a ctx uptodate.
418 int (*refresh) (struct ptlrpc_cli_ctx *ctx);
421 * Validate the \a ctx.
423 int (*validate) (struct ptlrpc_cli_ctx *ctx);
426 * Force the \a ctx to die.
428 void (*die) (struct ptlrpc_cli_ctx *ctx,
430 int (*display) (struct ptlrpc_cli_ctx *ctx,
431 char *buf, int bufsize);
434 * Sign the request message using \a ctx.
436 * \pre req->rq_reqmsg point to request message.
437 * \pre req->rq_reqlen is the request message length.
438 * \post req->rq_reqbuf point to request message with signature.
439 * \post req->rq_reqdata_len is set to the final request message size.
441 * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
443 int (*sign) (struct ptlrpc_cli_ctx *ctx,
444 struct ptlrpc_request *req);
447 * Verify the reply message using \a ctx.
449 * \pre req->rq_repdata point to reply message with signature.
450 * \pre req->rq_repdata_len is the total reply message length.
451 * \post req->rq_repmsg point to reply message without signature.
452 * \post req->rq_replen is the reply message length.
454 * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
456 int (*verify) (struct ptlrpc_cli_ctx *ctx,
457 struct ptlrpc_request *req);
460 * Encrypt the request message using \a ctx.
462 * \pre req->rq_reqmsg point to request message in clear text.
463 * \pre req->rq_reqlen is the request message length.
464 * \post req->rq_reqbuf point to request message.
465 * \post req->rq_reqdata_len is set to the final request message size.
467 * \see gss_cli_ctx_seal().
469 int (*seal) (struct ptlrpc_cli_ctx *ctx,
470 struct ptlrpc_request *req);
473 * Decrypt the reply message using \a ctx.
475 * \pre req->rq_repdata point to encrypted reply message.
476 * \pre req->rq_repdata_len is the total cipher text length.
477 * \post req->rq_repmsg point to reply message in clear text.
478 * \post req->rq_replen is the reply message length in clear text.
480 * \see gss_cli_ctx_unseal().
482 int (*unseal) (struct ptlrpc_cli_ctx *ctx,
483 struct ptlrpc_request *req);
486 * Wrap bulk request data. This is called before wrapping RPC
489 * \pre bulk buffer is descripted by desc->bd_iov and
490 * desc->bd_iov_count. note for read it's just buffer, no data
491 * need to be sent; for write it contains data in clear text.
492 * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
493 * (usually inside of RPC request message).
494 * - encryption: cipher text bulk buffer is descripted by
495 * desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
496 * count remains the same).
497 * - otherwise: bulk buffer is still desc->bd_iov and
498 * desc->bd_iov_count.
500 * \return 0: success.
501 * \return -ev: error code.
503 * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
505 int (*wrap_bulk) (struct ptlrpc_cli_ctx *ctx,
506 struct ptlrpc_request *req,
507 struct ptlrpc_bulk_desc *desc);
510 * Unwrap bulk reply data. This is called after wrapping RPC
513 * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
514 * desc->bd_iov_count, according to wrap_bulk().
515 * \post final bulk data in clear text is placed in buffer described
516 * by desc->bd_iov and desc->bd_iov_count.
517 * \return +ve nob of actual bulk data in clear text.
518 * \return -ve error code.
520 * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
522 int (*unwrap_bulk) (struct ptlrpc_cli_ctx *ctx,
523 struct ptlrpc_request *req,
524 struct ptlrpc_bulk_desc *desc);
527 #define PTLRPC_CTX_NEW_BIT (0) /* newly created */
528 #define PTLRPC_CTX_UPTODATE_BIT (1) /* uptodate */
529 #define PTLRPC_CTX_DEAD_BIT (2) /* mark expired gracefully */
530 #define PTLRPC_CTX_ERROR_BIT (3) /* fatal error (refresh, etc.) */
531 #define PTLRPC_CTX_CACHED_BIT (8) /* in ctx cache (hash etc.) */
532 #define PTLRPC_CTX_ETERNAL_BIT (9) /* always valid */
534 #define PTLRPC_CTX_NEW BIT(PTLRPC_CTX_NEW_BIT)
535 #define PTLRPC_CTX_UPTODATE BIT(PTLRPC_CTX_UPTODATE_BIT)
536 #define PTLRPC_CTX_DEAD BIT(PTLRPC_CTX_DEAD_BIT)
537 #define PTLRPC_CTX_ERROR BIT(PTLRPC_CTX_ERROR_BIT)
538 #define PTLRPC_CTX_CACHED BIT(PTLRPC_CTX_CACHED_BIT)
539 #define PTLRPC_CTX_ETERNAL BIT(PTLRPC_CTX_ETERNAL_BIT)
541 #define PTLRPC_CTX_STATUS_MASK (PTLRPC_CTX_NEW_BIT | \
542 PTLRPC_CTX_UPTODATE | \
546 struct ptlrpc_cli_ctx {
547 struct hlist_node cc_cache; /* linked into ctx cache */
548 atomic_t cc_refcount;
549 struct ptlrpc_sec *cc_sec;
550 struct ptlrpc_ctx_ops *cc_ops;
551 time64_t cc_expire; /* in seconds */
552 unsigned int cc_early_expire:1;
553 unsigned long cc_flags;
554 struct vfs_cred cc_vcred;
556 struct list_head cc_req_list; /* waiting reqs linked here */
557 struct list_head cc_gc_chain; /* linked to gc chain */
561 * client side policy operation vector.
563 struct ptlrpc_sec_cops {
565 * Given an \a imp, create and initialize a ptlrpc_sec structure.
566 * \param ctx service context:
567 * - regular import: \a ctx should be NULL;
568 * - reverse import: \a ctx is obtained from incoming request.
569 * \param flavor specify what flavor to use.
571 * When necessary, policy module is responsible for taking reference
574 * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
576 struct ptlrpc_sec * (*create_sec) (struct obd_import *imp,
577 struct ptlrpc_svc_ctx *ctx,
578 struct sptlrpc_flavor *flavor);
581 * Destructor of ptlrpc_sec. When called, refcount has been dropped
582 * to 0 and all contexts has been destroyed.
584 * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
586 void (*destroy_sec) (struct ptlrpc_sec *sec);
589 * Notify that this ptlrpc_sec is going to die. Optionally, policy
590 * module is supposed to set sec->ps_dying and whatever necessary
593 * \see plain_kill_sec(), gss_sec_kill().
595 void (*kill_sec) (struct ptlrpc_sec *sec);
598 * Given \a vcred, lookup and/or create its context. The policy module
599 * is supposed to maintain its own context cache.
600 * XXX currently \a create and \a remove_dead is always 1, perhaps
601 * should be removed completely.
603 * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
605 struct ptlrpc_cli_ctx * (*lookup_ctx) (struct ptlrpc_sec *sec,
606 struct vfs_cred *vcred,
611 * Called then the reference of \a ctx dropped to 0. The policy module
612 * is supposed to destroy this context or whatever else according to
613 * its cache maintainance mechamism.
615 * \param sync if zero, we shouldn't wait for the context being
616 * destroyed completely.
618 * \see plain_release_ctx(), gss_sec_release_ctx_kr().
620 void (*release_ctx) (struct ptlrpc_sec *sec,
621 struct ptlrpc_cli_ctx *ctx,
625 * Flush the context cache.
627 * \param uid context of which user, -1 means all contexts.
628 * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
629 * contexts should be cleared immediately.
630 * \param force if zero, only idle contexts will be flushed.
632 * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
634 int (*flush_ctx_cache)
635 (struct ptlrpc_sec *sec,
641 * Called periodically by garbage collector to remove dead contexts
644 * \see gss_sec_gc_ctx_kr().
646 void (*gc_ctx) (struct ptlrpc_sec *sec);
649 * Given an context \a ctx, install a corresponding reverse service
650 * context on client side.
651 * XXX currently it's only used by GSS module, maybe we should remove
652 * this from general API.
654 int (*install_rctx)(struct obd_import *imp,
655 struct ptlrpc_sec *sec,
656 struct ptlrpc_cli_ctx *ctx);
659 * To allocate request buffer for \a req.
661 * \pre req->rq_reqmsg == NULL.
662 * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
663 * we are not supposed to free it.
664 * \post if success, req->rq_reqmsg point to a buffer with size
665 * at least \a lustre_msg_size.
667 * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
669 int (*alloc_reqbuf)(struct ptlrpc_sec *sec,
670 struct ptlrpc_request *req,
671 int lustre_msg_size);
674 * To free request buffer for \a req.
676 * \pre req->rq_reqbuf != NULL.
678 * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
680 void (*free_reqbuf) (struct ptlrpc_sec *sec,
681 struct ptlrpc_request *req);
684 * To allocate reply buffer for \a req.
686 * \pre req->rq_repbuf == NULL.
687 * \post if success, req->rq_repbuf point to a buffer with size
688 * req->rq_repbuf_len, the size should be large enough to receive
689 * reply which be transformed from \a lustre_msg_size of clear text.
691 * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
693 int (*alloc_repbuf)(struct ptlrpc_sec *sec,
694 struct ptlrpc_request *req,
695 int lustre_msg_size);
698 * To free reply buffer for \a req.
700 * \pre req->rq_repbuf != NULL.
701 * \post req->rq_repbuf == NULL.
702 * \post req->rq_repbuf_len == 0.
704 * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
706 void (*free_repbuf) (struct ptlrpc_sec *sec,
707 struct ptlrpc_request *req);
710 * To expand the request buffer of \a req, thus the \a segment in
711 * the request message pointed by req->rq_reqmsg can accommodate
712 * at least \a newsize of data.
714 * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
716 * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
717 * gss_enlarge_reqbuf().
719 int (*enlarge_reqbuf)
720 (struct ptlrpc_sec *sec,
721 struct ptlrpc_request *req,
722 int segment, int newsize);
726 int (*display) (struct ptlrpc_sec *sec,
727 struct seq_file *seq);
731 * server side policy operation vector.
733 struct ptlrpc_sec_sops {
735 * verify an incoming request.
737 * \pre request message is pointed by req->rq_reqbuf, size is
738 * req->rq_reqdata_len; and the message has been unpacked to
741 * \retval SECSVC_OK success, req->rq_reqmsg point to request message
742 * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
743 * req->rq_sp_from is decoded from request.
744 * \retval SECSVC_COMPLETE success, the request has been fully
745 * processed, and reply message has been prepared; req->rq_sp_from is
746 * decoded from request.
747 * \retval SECSVC_DROP failed, this request should be dropped.
749 * \see null_accept(), plain_accept(), gss_svc_accept_kr().
751 int (*accept) (struct ptlrpc_request *req);
754 * Perform security transformation upon reply message.
756 * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
758 * \post req->rs_repdata_len is the final message size.
759 * \post req->rq_reply_off is set.
761 * \see null_authorize(), plain_authorize(), gss_svc_authorize().
763 int (*authorize) (struct ptlrpc_request *req);
766 * Invalidate server context \a ctx.
768 * \see gss_svc_invalidate_ctx().
770 void (*invalidate_ctx)
771 (struct ptlrpc_svc_ctx *ctx);
774 * Allocate a ptlrpc_reply_state.
776 * \param msgsize size of the reply message in clear text.
777 * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
778 * should simply use it; otherwise we'll responsible for allocating
780 * \post req->rq_reply_state != NULL;
781 * \post req->rq_reply_state->rs_msg != NULL;
783 * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
785 int (*alloc_rs) (struct ptlrpc_request *req,
789 * Free a ptlrpc_reply_state.
791 void (*free_rs) (struct ptlrpc_reply_state *rs);
794 * Release the server context \a ctx.
796 * \see gss_svc_free_ctx().
798 void (*free_ctx) (struct ptlrpc_svc_ctx *ctx);
801 * Install a reverse context based on the server context \a ctx.
803 * \see gss_svc_install_rctx_kr().
805 int (*install_rctx)(struct obd_import *imp,
806 struct ptlrpc_svc_ctx *ctx);
809 * Prepare buffer for incoming bulk write.
811 * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
812 * intended to receive the write.
814 * \see gss_svc_prep_bulk().
816 int (*prep_bulk) (struct ptlrpc_request *req,
817 struct ptlrpc_bulk_desc *desc);
820 * Unwrap the bulk write data.
822 * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
824 int (*unwrap_bulk) (struct ptlrpc_request *req,
825 struct ptlrpc_bulk_desc *desc);
828 * Wrap the bulk read data.
830 * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
832 int (*wrap_bulk) (struct ptlrpc_request *req,
833 struct ptlrpc_bulk_desc *desc);
836 struct ptlrpc_sec_policy {
837 struct module *sp_owner;
839 __u16 sp_policy; /* policy number */
840 struct ptlrpc_sec_cops *sp_cops; /* client ops */
841 struct ptlrpc_sec_sops *sp_sops; /* server ops */
844 #define PTLRPC_SEC_FL_REVERSE 0x0001 /* reverse sec */
845 #define PTLRPC_SEC_FL_ROOTONLY 0x0002 /* treat everyone as root */
846 #define PTLRPC_SEC_FL_UDESC 0x0004 /* ship udesc */
847 #define PTLRPC_SEC_FL_BULK 0x0008 /* intensive bulk i/o expected */
848 #define PTLRPC_SEC_FL_PAG 0x0010 /* PAG mode */
851 * The ptlrpc_sec represents the client side ptlrpc security facilities,
852 * each obd_import (both regular and reverse import) must associate with
855 * \see sptlrpc_import_sec_adapt().
858 struct ptlrpc_sec_policy *ps_policy;
859 atomic_t ps_refcount;
860 /** statistic only */
862 /** unique identifier */
864 struct sptlrpc_flavor ps_flvr;
865 enum lustre_sec_part ps_part;
866 /** after set, no more new context will be created */
867 unsigned int ps_dying:1;
869 struct obd_import *ps_import;
871 /** mtime of SELinux policy file */
872 ktime_t ps_sepol_mtime;
873 /** next check time of SELinux policy file */
874 ktime_t ps_sepol_checknext;
876 * SELinux policy info
877 * sepol string format is:
878 * <mode>:<policy name>:<policy version>:<policy hash>
880 char ps_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH
886 struct list_head ps_gc_list;
887 time64_t ps_gc_interval; /* in seconds */
888 time64_t ps_gc_next; /* in seconds */
891 static inline int flvr_is_rootonly(__u32 flavor)
893 return (SPTLRPC_FLVR_POLICY(flavor) == SPTLRPC_POLICY_GSS &&
894 (SPTLRPC_FLVR_MECH(flavor) == SPTLRPC_MECH_GSS_NULL ||
895 SPTLRPC_FLVR_MECH(flavor) == SPTLRPC_MECH_GSS_SK));
898 static inline int flvr_allows_user_desc(__u32 flavor)
900 return (SPTLRPC_FLVR_POLICY(flavor) == SPTLRPC_POLICY_GSS &&
901 (SPTLRPC_FLVR_MECH(flavor) == SPTLRPC_MECH_GSS_NULL ||
902 SPTLRPC_FLVR_MECH(flavor) == SPTLRPC_MECH_GSS_SK));
905 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
907 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
910 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
912 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
916 struct ptlrpc_svc_ctx {
917 atomic_t sc_refcount;
918 struct ptlrpc_sec_policy *sc_policy;
922 * user identity descriptor
924 #define LUSTRE_MAX_GROUPS (128)
926 struct ptlrpc_user_desc {
939 enum sptlrpc_bulk_hash_alg {
940 BULK_HASH_ALG_NULL = 0,
941 BULK_HASH_ALG_ADLER32,
945 BULK_HASH_ALG_SHA256,
946 BULK_HASH_ALG_SHA384,
947 BULK_HASH_ALG_SHA512,
951 const char * sptlrpc_get_hash_name(__u8 hash_alg);
952 __u8 sptlrpc_get_hash_alg(const char *algname);
958 struct ptlrpc_bulk_sec_desc {
959 __u8 bsd_version; /* 0 */
960 __u8 bsd_type; /* SPTLRPC_BULK_XXX */
961 __u8 bsd_svc; /* SPTLRPC_BULK_SVC_XXXX */
962 __u8 bsd_flags; /* flags */
963 __u32 bsd_nob; /* nob of bulk data */
964 __u8 bsd_data[0]; /* policy-specific token */
967 extern struct dentry *sptlrpc_debugfs_dir;
968 extern struct proc_dir_entry *sptlrpc_lprocfs_dir;
971 * round size up to next power of 2, for slab allocation.
972 * @size must be sane (can't overflow after round up)
974 static inline int size_roundup_power2(int size)
987 * internal support libraries
989 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
990 int segment, int newsize);
995 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
996 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
998 __u32 sptlrpc_name2flavor_base(const char *name);
999 const char *sptlrpc_flavor2name_base(__u32 flvr);
1000 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
1001 char *buf, int bufsize);
1002 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
1003 char *sptlrpc_secflags2str(__u32 flags, char *buf, int bufsize);
1005 static inline struct ptlrpc_sec_policy *
1006 sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
1008 __module_get(policy->sp_owner);
1013 sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
1015 module_put(policy->sp_owner);
1022 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
1024 return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
1028 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
1030 return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
1034 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
1036 return (cli_ctx_status(ctx) != 0);
1040 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
1042 return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
1046 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
1048 return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
1052 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
1054 return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
1058 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
1060 return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
1066 struct ptlrpc_sec *sptlrpc_sec_get(struct ptlrpc_sec *sec);
1067 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
1070 * internal apis which only used by policy impelentation
1072 int sptlrpc_get_next_secid(void);
1073 void sptlrpc_sec_destroy(struct ptlrpc_sec *sec);
1076 * exported client context api
1078 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
1079 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
1080 void sptlrpc_cli_ctx_expire(struct ptlrpc_cli_ctx *ctx);
1081 void sptlrpc_cli_ctx_wakeup(struct ptlrpc_cli_ctx *ctx);
1082 int sptlrpc_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
1085 * exported client context wrap/buffers
1087 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
1088 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
1089 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
1090 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
1091 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
1092 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
1093 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1094 const struct req_msg_field *field,
1096 int sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1097 struct ptlrpc_request **req_ret);
1098 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
1100 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
1101 int sptlrpc_get_sepol(struct ptlrpc_request *req);
1104 * exported higher interface of import & request
1106 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1107 struct ptlrpc_svc_ctx *ctx,
1108 struct sptlrpc_flavor *flvr);
1109 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
1110 void sptlrpc_import_sec_put(struct obd_import *imp);
1112 int sptlrpc_import_check_ctx(struct obd_import *imp);
1113 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
1114 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
1115 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
1116 int sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1117 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1118 int sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1119 int sptlrpc_export_update_ctx(struct obd_export *exp);
1120 int sptlrpc_req_replace_dead_ctx(struct ptlrpc_request *req);
1121 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1123 int sptlrpc_parse_rule(char *param, struct sptlrpc_rule *rule);
1126 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1127 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1128 void sptlrpc_gc_add_ctx(struct ptlrpc_cli_ctx *ctx);
1131 const char * sec2target_str(struct ptlrpc_sec *sec);
1132 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *obd);
1137 enum secsvc_accept_res {
1143 int sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1144 int sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1145 int sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1146 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1147 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1148 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1149 void sptlrpc_svc_ctx_invalidate(struct ptlrpc_request *req);
1151 int sptlrpc_target_export_check(struct obd_export *exp,
1152 struct ptlrpc_request *req);
1153 void sptlrpc_target_update_exp_flavor(struct obd_device *obd,
1154 struct sptlrpc_rule_set *rset);
1159 int sptlrpc_svc_install_rvs_ctx(struct obd_import *imp,
1160 struct ptlrpc_svc_ctx *ctx);
1161 int sptlrpc_cli_install_rvs_ctx(struct obd_import *imp,
1162 struct ptlrpc_cli_ctx *ctx);
1164 /* bulk security api */
1165 int sptlrpc_enc_pool_add_user(void);
1166 int sptlrpc_enc_pool_del_user(void);
1167 int sptlrpc_enc_pool_get_pages(struct ptlrpc_bulk_desc *desc);
1168 int sptlrpc_enc_pool_get_pages_array(struct page **pa, unsigned int count);
1169 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1170 void sptlrpc_enc_pool_put_pages_array(struct page **pa, unsigned int count);
1171 int get_free_pages_in_pool(void);
1172 int pool_is_at_full_capacity(void);
1174 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1175 struct ptlrpc_bulk_desc *desc);
1176 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1177 struct ptlrpc_bulk_desc *desc,
1179 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1180 struct ptlrpc_bulk_desc *desc);
1181 #ifdef HAVE_SERVER_SUPPORT
1182 int sptlrpc_svc_prep_bulk(struct ptlrpc_request *req,
1183 struct ptlrpc_bulk_desc *desc);
1184 int sptlrpc_svc_wrap_bulk(struct ptlrpc_request *req,
1185 struct ptlrpc_bulk_desc *desc);
1186 int sptlrpc_svc_unwrap_bulk(struct ptlrpc_request *req,
1187 struct ptlrpc_bulk_desc *desc);
1190 /* bulk helpers (internal use only by policies) */
1191 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1192 void *buf, int buflen);
1194 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1196 /* user descriptor helpers */
1197 static inline int sptlrpc_user_desc_size(int ngroups)
1199 return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1202 int sptlrpc_current_user_desc_size(void);
1203 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1204 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1208 #endif /* _LUSTRE_SEC_H_ */