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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _LUSTRE_SEC_H_
38 #define _LUSTRE_SEC_H_
40 /** \defgroup sptlrpc sptlrpc
50 struct ptlrpc_request;
51 struct ptlrpc_reply_state;
52 struct ptlrpc_bulk_desc;
61 struct ptlrpc_sec_policy;
62 struct ptlrpc_sec_cops;
63 struct ptlrpc_sec_sops;
65 struct ptlrpc_svc_ctx;
66 struct ptlrpc_cli_ctx;
67 struct ptlrpc_ctx_ops;
70 * \addtogroup flavor flavor
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.
75 * ------------------------------------------------------------------------
76 * | 4b (bulk svc) | 4b (bulk type) | 4b (svc) | 4b (mech) | 4b (policy) |
77 * ------------------------------------------------------------------------
87 SPTLRPC_POLICY_NULL = 0,
88 SPTLRPC_POLICY_PLAIN = 1,
89 SPTLRPC_POLICY_GSS = 2,
93 enum sptlrpc_mech_null {
94 SPTLRPC_MECH_NULL = 0,
95 SPTLRPC_MECH_NULL_MAX,
98 enum sptlrpc_mech_plain {
99 SPTLRPC_MECH_PLAIN = 0,
100 SPTLRPC_MECH_PLAIN_MAX,
103 enum sptlrpc_mech_gss {
104 SPTLRPC_MECH_GSS_NULL = 0,
105 SPTLRPC_MECH_GSS_KRB5 = 1,
106 SPTLRPC_MECH_GSS_MAX,
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 */
117 enum sptlrpc_bulk_type {
118 SPTLRPC_BULK_DEFAULT = 0, /**< follow rpc flavor */
119 SPTLRPC_BULK_HASH = 1, /**< hash integrity */
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,
132 * compose/extract macros
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)
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))
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)
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)
169 #define MAKE_BASE_SUBFLVR(mech, svc) \
171 ((__u32)(svc) << (FLVR_SVC_OFFSET - FLVR_MECH_OFFSET)))
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)
185 #define SPTLRPC_FLVR_NULL \
186 MAKE_FLVR(SPTLRPC_POLICY_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, \
196 SPTLRPC_BULK_SVC_INTG)
197 #define SPTLRPC_FLVR_KRB5N \
198 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
199 SPTLRPC_MECH_GSS_KRB5, \
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, \
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, \
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, \
219 SPTLRPC_BULK_DEFAULT, \
220 SPTLRPC_BULK_SVC_PRIV)
222 #define SPTLRPC_FLVR_DEFAULT SPTLRPC_FLVR_NULL
224 #define SPTLRPC_FLVR_INVALID ((__u32) 0xFFFFFFFF)
225 #define SPTLRPC_FLVR_ANY ((__u32) 0xFFF00000)
228 * extract the useful part from wire flavor
230 #define WIRE_FLVR(wflvr) (((__u32) (wflvr)) & 0x000FFFFF)
234 static inline void flvr_set_svc(__u32 *flvr, __u32 svc)
236 LASSERT(svc < SPTLRPC_SVC_MAX);
237 *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
238 SPTLRPC_FLVR_MECH(*flvr),
240 SPTLRPC_FLVR_BULK_TYPE(*flvr),
241 SPTLRPC_FLVR_BULK_SVC(*flvr));
244 static inline void flvr_set_bulk_svc(__u32 *flvr, __u32 svc)
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),
254 struct bulk_spec_hash {
259 * Full description of flavors being used on a ptlrpc connection, include
260 * both regular RPC and bulk transfer parts.
262 struct sptlrpc_flavor {
264 * wire flavor, should be renamed to sf_wire.
268 * general flags of PTLRPC_SEC_FL_*
272 * rpc flavor specification
275 /* nothing for now */
278 * bulk flavor specification
281 struct bulk_spec_hash hash;
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.
289 enum lustre_sec_part {
298 enum lustre_sec_part sptlrpc_target_sec_part(struct obd_device *obd);
301 * A rule specifies a flavor to be used by a ptlrpc connection between
304 struct sptlrpc_rule {
305 __u32 sr_netid; /* LNET network ID */
306 __u8 sr_from; /* sec_part */
307 __u8 sr_to; /* sec_part */
309 struct sptlrpc_flavor sr_flvr;
313 * A set of rules in memory.
315 * Rules are generated and stored on MGS, and propagated to MDT, OST,
316 * and client when needed.
318 struct sptlrpc_rule_set {
321 struct sptlrpc_rule *srs_rules;
324 int sptlrpc_parse_flavor(const char *str, struct sptlrpc_flavor *flvr);
325 bool sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr);
327 static inline void sptlrpc_rule_set_init(struct sptlrpc_rule_set *set)
329 memset(set, 0, sizeof(*set));
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);
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.
343 #define SPTLRPC_MAX_PAYLOAD (1024)
350 struct ptlrpc_ctx_ops {
352 * To determine whether it's suitable to use the \a ctx for \a vcred.
354 int (*match) (struct ptlrpc_cli_ctx *ctx,
355 struct vfs_cred *vcred);
358 * To bring the \a ctx uptodate.
360 int (*refresh) (struct ptlrpc_cli_ctx *ctx);
363 * Validate the \a ctx.
365 int (*validate) (struct ptlrpc_cli_ctx *ctx);
368 * Force the \a ctx to die.
370 void (*force_die) (struct ptlrpc_cli_ctx *ctx,
372 int (*display) (struct ptlrpc_cli_ctx *ctx,
373 char *buf, int bufsize);
376 * Sign the request message using \a ctx.
378 * \pre req->rq_reqmsg point to request message.
379 * \pre req->rq_reqlen is the request message length.
380 * \post req->rq_reqbuf point to request message with signature.
381 * \post req->rq_reqdata_len is set to the final request message size.
383 * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
385 int (*sign) (struct ptlrpc_cli_ctx *ctx,
386 struct ptlrpc_request *req);
389 * Verify the reply message using \a ctx.
391 * \pre req->rq_repdata point to reply message with signature.
392 * \pre req->rq_repdata_len is the total reply message length.
393 * \post req->rq_repmsg point to reply message without signature.
394 * \post req->rq_replen is the reply message length.
396 * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
398 int (*verify) (struct ptlrpc_cli_ctx *ctx,
399 struct ptlrpc_request *req);
402 * Encrypt the request message using \a ctx.
404 * \pre req->rq_reqmsg point to request message in clear text.
405 * \pre req->rq_reqlen is the request message length.
406 * \post req->rq_reqbuf point to request message.
407 * \post req->rq_reqdata_len is set to the final request message size.
409 * \see gss_cli_ctx_seal().
411 int (*seal) (struct ptlrpc_cli_ctx *ctx,
412 struct ptlrpc_request *req);
415 * Decrypt the reply message using \a ctx.
417 * \pre req->rq_repdata point to encrypted reply message.
418 * \pre req->rq_repdata_len is the total cipher text length.
419 * \post req->rq_repmsg point to reply message in clear text.
420 * \post req->rq_replen is the reply message length in clear text.
422 * \see gss_cli_ctx_unseal().
424 int (*unseal) (struct ptlrpc_cli_ctx *ctx,
425 struct ptlrpc_request *req);
428 * Wrap bulk request data. This is called before wrapping RPC
431 * \pre bulk buffer is descripted by desc->bd_iov and
432 * desc->bd_iov_count. note for read it's just buffer, no data
433 * need to be sent; for write it contains data in clear text.
434 * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
435 * (usually inside of RPC request message).
436 * - encryption: cipher text bulk buffer is descripted by
437 * desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
438 * count remains the same).
439 * - otherwise: bulk buffer is still desc->bd_iov and
440 * desc->bd_iov_count.
442 * \return 0: success.
443 * \return -ev: error code.
445 * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
447 int (*wrap_bulk) (struct ptlrpc_cli_ctx *ctx,
448 struct ptlrpc_request *req,
449 struct ptlrpc_bulk_desc *desc);
452 * Unwrap bulk reply data. This is called after wrapping RPC
455 * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
456 * desc->bd_iov_count, according to wrap_bulk().
457 * \post final bulk data in clear text is placed in buffer described
458 * by desc->bd_iov and desc->bd_iov_count.
459 * \return +ve nob of actual bulk data in clear text.
460 * \return -ve error code.
462 * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
464 int (*unwrap_bulk) (struct ptlrpc_cli_ctx *ctx,
465 struct ptlrpc_request *req,
466 struct ptlrpc_bulk_desc *desc);
469 #define PTLRPC_CTX_NEW_BIT (0) /* newly created */
470 #define PTLRPC_CTX_UPTODATE_BIT (1) /* uptodate */
471 #define PTLRPC_CTX_DEAD_BIT (2) /* mark expired gracefully */
472 #define PTLRPC_CTX_ERROR_BIT (3) /* fatal error (refresh, etc.) */
473 #define PTLRPC_CTX_CACHED_BIT (8) /* in ctx cache (hash etc.) */
474 #define PTLRPC_CTX_ETERNAL_BIT (9) /* always valid */
476 #define PTLRPC_CTX_NEW (1 << PTLRPC_CTX_NEW_BIT)
477 #define PTLRPC_CTX_UPTODATE (1 << PTLRPC_CTX_UPTODATE_BIT)
478 #define PTLRPC_CTX_DEAD (1 << PTLRPC_CTX_DEAD_BIT)
479 #define PTLRPC_CTX_ERROR (1 << PTLRPC_CTX_ERROR_BIT)
480 #define PTLRPC_CTX_CACHED (1 << PTLRPC_CTX_CACHED_BIT)
481 #define PTLRPC_CTX_ETERNAL (1 << PTLRPC_CTX_ETERNAL_BIT)
483 #define PTLRPC_CTX_STATUS_MASK (PTLRPC_CTX_NEW_BIT | \
484 PTLRPC_CTX_UPTODATE | \
488 struct ptlrpc_cli_ctx {
489 struct hlist_node cc_cache; /* linked into ctx cache */
490 atomic_t cc_refcount;
491 struct ptlrpc_sec *cc_sec;
492 struct ptlrpc_ctx_ops *cc_ops;
493 unsigned long cc_expire; /* in seconds */
494 unsigned int cc_early_expire:1;
495 unsigned long cc_flags;
496 struct vfs_cred cc_vcred;
498 struct list_head cc_req_list; /* waiting reqs linked here */
499 struct list_head cc_gc_chain; /* linked to gc chain */
503 * client side policy operation vector.
505 struct ptlrpc_sec_cops {
507 * Given an \a imp, create and initialize a ptlrpc_sec structure.
508 * \param ctx service context:
509 * - regular import: \a ctx should be NULL;
510 * - reverse import: \a ctx is obtained from incoming request.
511 * \param flavor specify what flavor to use.
513 * When necessary, policy module is responsible for taking reference
516 * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
518 struct ptlrpc_sec * (*create_sec) (struct obd_import *imp,
519 struct ptlrpc_svc_ctx *ctx,
520 struct sptlrpc_flavor *flavor);
523 * Destructor of ptlrpc_sec. When called, refcount has been dropped
524 * to 0 and all contexts has been destroyed.
526 * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
528 void (*destroy_sec) (struct ptlrpc_sec *sec);
531 * Notify that this ptlrpc_sec is going to die. Optionally, policy
532 * module is supposed to set sec->ps_dying and whatever necessary
535 * \see plain_kill_sec(), gss_sec_kill().
537 void (*kill_sec) (struct ptlrpc_sec *sec);
540 * Given \a vcred, lookup and/or create its context. The policy module
541 * is supposed to maintain its own context cache.
542 * XXX currently \a create and \a remove_dead is always 1, perhaps
543 * should be removed completely.
545 * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
547 struct ptlrpc_cli_ctx * (*lookup_ctx) (struct ptlrpc_sec *sec,
548 struct vfs_cred *vcred,
553 * Called then the reference of \a ctx dropped to 0. The policy module
554 * is supposed to destroy this context or whatever else according to
555 * its cache maintenance mechanism.
557 * \param sync if zero, we shouldn't wait for the context being
558 * destroyed completely.
560 * \see plain_release_ctx(), gss_sec_release_ctx_kr().
562 void (*release_ctx) (struct ptlrpc_sec *sec,
563 struct ptlrpc_cli_ctx *ctx,
567 * Flush the context cache.
569 * \param uid context of which user, -1 means all contexts.
570 * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
571 * contexts should be cleared immediately.
572 * \param force if zero, only idle contexts will be flushed.
574 * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
576 int (*flush_ctx_cache)
577 (struct ptlrpc_sec *sec,
583 * Called periodically by garbage collector to remove dead contexts
586 * \see gss_sec_gc_ctx_kr().
588 void (*gc_ctx) (struct ptlrpc_sec *sec);
591 * Given an context \a ctx, install a corresponding reverse service
592 * context on client side.
593 * XXX currently it's only used by GSS module, maybe we should remove
594 * this from general API.
596 int (*install_rctx)(struct obd_import *imp,
597 struct ptlrpc_sec *sec,
598 struct ptlrpc_cli_ctx *ctx);
601 * To allocate request buffer for \a req.
603 * \pre req->rq_reqmsg == NULL.
604 * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
605 * we are not supposed to free it.
606 * \post if success, req->rq_reqmsg point to a buffer with size
607 * at least \a lustre_msg_size.
609 * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
611 int (*alloc_reqbuf)(struct ptlrpc_sec *sec,
612 struct ptlrpc_request *req,
613 int lustre_msg_size);
616 * To free request buffer for \a req.
618 * \pre req->rq_reqbuf != NULL.
620 * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
622 void (*free_reqbuf) (struct ptlrpc_sec *sec,
623 struct ptlrpc_request *req);
626 * To allocate reply buffer for \a req.
628 * \pre req->rq_repbuf == NULL.
629 * \post if success, req->rq_repbuf point to a buffer with size
630 * req->rq_repbuf_len, the size should be large enough to receive
631 * reply which be transformed from \a lustre_msg_size of clear text.
633 * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
635 int (*alloc_repbuf)(struct ptlrpc_sec *sec,
636 struct ptlrpc_request *req,
637 int lustre_msg_size);
640 * To free reply buffer for \a req.
642 * \pre req->rq_repbuf != NULL.
643 * \post req->rq_repbuf == NULL.
644 * \post req->rq_repbuf_len == 0.
646 * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
648 void (*free_repbuf) (struct ptlrpc_sec *sec,
649 struct ptlrpc_request *req);
652 * To expand the request buffer of \a req, thus the \a segment in
653 * the request message pointed by req->rq_reqmsg can accommodate
654 * at least \a newsize of data.
656 * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
658 * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
659 * gss_enlarge_reqbuf().
661 int (*enlarge_reqbuf)
662 (struct ptlrpc_sec *sec,
663 struct ptlrpc_request *req,
664 int segment, int newsize);
668 int (*display) (struct ptlrpc_sec *sec,
669 struct seq_file *seq);
673 * server side policy operation vector.
675 struct ptlrpc_sec_sops {
677 * verify an incoming request.
679 * \pre request message is pointed by req->rq_reqbuf, size is
680 * req->rq_reqdata_len; and the message has been unpacked to
683 * \retval SECSVC_OK success, req->rq_reqmsg point to request message
684 * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
685 * req->rq_sp_from is decoded from request.
686 * \retval SECSVC_COMPLETE success, the request has been fully
687 * processed, and reply message has been prepared; req->rq_sp_from is
688 * decoded from request.
689 * \retval SECSVC_DROP failed, this request should be dropped.
691 * \see null_accept(), plain_accept(), gss_svc_accept_kr().
693 int (*accept) (struct ptlrpc_request *req);
696 * Perform security transformation upon reply message.
698 * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
700 * \post req->rs_repdata_len is the final message size.
701 * \post req->rq_reply_off is set.
703 * \see null_authorize(), plain_authorize(), gss_svc_authorize().
705 int (*authorize) (struct ptlrpc_request *req);
708 * Invalidate server context \a ctx.
710 * \see gss_svc_invalidate_ctx().
712 void (*invalidate_ctx)
713 (struct ptlrpc_svc_ctx *ctx);
716 * Allocate a ptlrpc_reply_state.
718 * \param msgsize size of the reply message in clear text.
719 * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
720 * should simply use it; otherwise we'll responsible for allocating
722 * \post req->rq_reply_state != NULL;
723 * \post req->rq_reply_state->rs_msg != NULL;
725 * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
727 int (*alloc_rs) (struct ptlrpc_request *req,
731 * Free a ptlrpc_reply_state.
733 void (*free_rs) (struct ptlrpc_reply_state *rs);
736 * Release the server context \a ctx.
738 * \see gss_svc_free_ctx().
740 void (*free_ctx) (struct ptlrpc_svc_ctx *ctx);
743 * Install a reverse context based on the server context \a ctx.
745 * \see gss_svc_install_rctx_kr().
747 int (*install_rctx)(struct obd_import *imp,
748 struct ptlrpc_svc_ctx *ctx);
751 * Prepare buffer for incoming bulk write.
753 * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
754 * intended to receive the write.
756 * \see gss_svc_prep_bulk().
758 int (*prep_bulk) (struct ptlrpc_request *req,
759 struct ptlrpc_bulk_desc *desc);
762 * Unwrap the bulk write data.
764 * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
766 int (*unwrap_bulk) (struct ptlrpc_request *req,
767 struct ptlrpc_bulk_desc *desc);
770 * Wrap the bulk read data.
772 * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
774 int (*wrap_bulk) (struct ptlrpc_request *req,
775 struct ptlrpc_bulk_desc *desc);
778 struct ptlrpc_sec_policy {
779 struct module *sp_owner;
781 __u16 sp_policy; /* policy number */
782 struct ptlrpc_sec_cops *sp_cops; /* client ops */
783 struct ptlrpc_sec_sops *sp_sops; /* server ops */
786 #define PTLRPC_SEC_FL_REVERSE 0x0001 /* reverse sec */
787 #define PTLRPC_SEC_FL_ROOTONLY 0x0002 /* treat everyone as root */
788 #define PTLRPC_SEC_FL_UDESC 0x0004 /* ship udesc */
789 #define PTLRPC_SEC_FL_BULK 0x0008 /* intensive bulk i/o expected */
790 #define PTLRPC_SEC_FL_PAG 0x0010 /* PAG mode */
793 * The ptlrpc_sec represents the client side ptlrpc security facilities,
794 * each obd_import (both regular and reverse import) must associate with
797 * \see sptlrpc_import_sec_adapt().
800 struct ptlrpc_sec_policy *ps_policy;
801 atomic_t ps_refcount;
802 /** statistic only */
804 /** unique identifier */
806 struct sptlrpc_flavor ps_flvr;
807 enum lustre_sec_part ps_part;
808 /** after set, no more new context will be created */
809 unsigned int ps_dying:1;
811 struct obd_import *ps_import;
817 struct list_head ps_gc_list;
818 unsigned long ps_gc_interval; /* in seconds */
819 time64_t ps_gc_next; /* in seconds */
822 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
824 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
827 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
829 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
832 struct ptlrpc_svc_ctx {
833 atomic_t sc_refcount;
834 struct ptlrpc_sec_policy *sc_policy;
838 * user identity descriptor
840 #define LUSTRE_MAX_GROUPS (128)
842 struct ptlrpc_user_desc {
855 enum sptlrpc_bulk_hash_alg {
856 BULK_HASH_ALG_NULL = 0,
857 BULK_HASH_ALG_ADLER32,
861 BULK_HASH_ALG_SHA256,
862 BULK_HASH_ALG_SHA384,
863 BULK_HASH_ALG_SHA512,
867 const char *sptlrpc_get_hash_name(__u8 hash_alg);
868 __u8 sptlrpc_get_hash_alg(const char *algname);
874 struct ptlrpc_bulk_sec_desc {
875 __u8 bsd_version; /* 0 */
876 __u8 bsd_type; /* SPTLRPC_BULK_XXX */
877 __u8 bsd_svc; /* SPTLRPC_BULK_SVC_XXXX */
878 __u8 bsd_flags; /* flags */
879 __u32 bsd_nob; /* nob of bulk data */
880 __u8 bsd_data[0]; /* policy-specific token */
884 * round size up to next power of 2, for slab allocation.
885 * @size must be sane (can't overflow after round up)
887 static inline int size_roundup_power2(int size)
900 * internal support libraries
902 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
903 int segment, int newsize);
908 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
909 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
911 __u32 sptlrpc_name2flavor_base(const char *name);
912 const char *sptlrpc_flavor2name_base(__u32 flvr);
913 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
914 char *buf, int bufsize);
915 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
918 struct ptlrpc_sec_policy *sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
920 __module_get(policy->sp_owner);
925 void sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
927 module_put(policy->sp_owner);
934 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
936 return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
940 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
942 return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
946 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
948 return (cli_ctx_status(ctx) != 0);
952 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
954 return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
958 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
960 return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
964 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
966 return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
970 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
972 return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
978 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
981 * internal apis which only used by policy implementation
983 int sptlrpc_get_next_secid(void);
986 * exported client context api
988 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
989 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
992 * exported client context wrap/buffers
994 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
995 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
996 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
997 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
998 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
999 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
1000 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1001 int segment, int newsize);
1002 int sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1003 struct ptlrpc_request **req_ret);
1004 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
1006 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
1009 * exported higher interface of import & request
1011 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1012 struct ptlrpc_svc_ctx *ctx,
1013 struct sptlrpc_flavor *flvr);
1014 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
1015 void sptlrpc_import_sec_put(struct obd_import *imp);
1017 int sptlrpc_import_check_ctx(struct obd_import *imp);
1018 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
1019 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
1020 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
1021 int sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1022 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1023 int sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1024 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1027 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1028 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1031 const char *sec2target_str(struct ptlrpc_sec *sec);
1035 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *dev);
1040 enum secsvc_accept_res {
1046 int sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1047 int sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1048 int sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1049 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1050 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1051 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1053 int sptlrpc_target_export_check(struct obd_export *exp,
1054 struct ptlrpc_request *req);
1056 /* bulk security api */
1057 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1059 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1060 struct ptlrpc_bulk_desc *desc);
1061 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1062 struct ptlrpc_bulk_desc *desc,
1064 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1065 struct ptlrpc_bulk_desc *desc);
1067 /* bulk helpers (internal use only by policies) */
1068 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1069 void *buf, int buflen);
1071 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1073 /* user descriptor helpers */
1074 static inline int sptlrpc_user_desc_size(int ngroups)
1076 return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1079 int sptlrpc_current_user_desc_size(void);
1080 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1081 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1083 #define CFS_CAP_CHOWN_MASK (1 << CFS_CAP_CHOWN)
1084 #define CFS_CAP_SYS_RESOURCE_MASK (1 << CFS_CAP_SYS_RESOURCE)
1087 LUSTRE_SEC_NONE = 0,
1088 LUSTRE_SEC_REMOTE = 1,
1089 LUSTRE_SEC_SPECIFY = 2,
1095 #endif /* _LUSTRE_SEC_H_ */