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 const char *sptlrpc_part2name(enum lustre_sec_part sp);
299 enum lustre_sec_part sptlrpc_target_sec_part(struct obd_device *obd);
302 * A rule specifies a flavor to be used by a ptlrpc connection between
305 struct sptlrpc_rule {
306 __u32 sr_netid; /* LNET network ID */
307 __u8 sr_from; /* sec_part */
308 __u8 sr_to; /* sec_part */
310 struct sptlrpc_flavor sr_flvr;
314 * A set of rules in memory.
316 * Rules are generated and stored on MGS, and propagated to MDT, OST,
317 * and client when needed.
319 struct sptlrpc_rule_set {
322 struct sptlrpc_rule *srs_rules;
325 int sptlrpc_parse_flavor(const char *str, struct sptlrpc_flavor *flvr);
326 int sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr);
328 static inline void sptlrpc_rule_set_init(struct sptlrpc_rule_set *set)
330 memset(set, 0, sizeof(*set));
333 void sptlrpc_rule_set_free(struct sptlrpc_rule_set *set);
334 int sptlrpc_rule_set_expand(struct sptlrpc_rule_set *set);
335 int sptlrpc_rule_set_merge(struct sptlrpc_rule_set *set,
336 struct sptlrpc_rule *rule);
337 int sptlrpc_rule_set_choose(struct sptlrpc_rule_set *rset,
338 enum lustre_sec_part from,
339 enum lustre_sec_part to,
341 struct sptlrpc_flavor *sf);
342 void sptlrpc_rule_set_dump(struct sptlrpc_rule_set *set);
344 int sptlrpc_process_config(struct lustre_cfg *lcfg);
345 void sptlrpc_conf_log_start(const char *logname);
346 void sptlrpc_conf_log_stop(const char *logname);
347 void sptlrpc_conf_log_update_begin(const char *logname);
348 void sptlrpc_conf_log_update_end(const char *logname);
349 void sptlrpc_conf_client_adapt(struct obd_device *obd);
350 int sptlrpc_conf_target_get_rules(struct obd_device *obd,
351 struct sptlrpc_rule_set *rset,
353 void sptlrpc_target_choose_flavor(struct sptlrpc_rule_set *rset,
354 enum lustre_sec_part from,
356 struct sptlrpc_flavor *flavor);
358 /* The maximum length of security payload. 1024 is enough for Kerberos 5,
359 * and should be enough for other future mechanisms but not sure.
360 * Only used by pre-allocated request/reply pool.
362 #define SPTLRPC_MAX_PAYLOAD (1024)
370 struct ptlrpc_ctx_ops {
372 * To determine whether it's suitable to use the \a ctx for \a vcred.
374 int (*match) (struct ptlrpc_cli_ctx *ctx,
375 struct vfs_cred *vcred);
378 * To bring the \a ctx uptodate.
380 int (*refresh) (struct ptlrpc_cli_ctx *ctx);
383 * Validate the \a ctx.
385 int (*validate) (struct ptlrpc_cli_ctx *ctx);
388 * Force the \a ctx to die.
390 void (*die) (struct ptlrpc_cli_ctx *ctx,
392 int (*display) (struct ptlrpc_cli_ctx *ctx,
393 char *buf, int bufsize);
396 * Sign the request message using \a ctx.
398 * \pre req->rq_reqmsg point to request message.
399 * \pre req->rq_reqlen is the request message length.
400 * \post req->rq_reqbuf point to request message with signature.
401 * \post req->rq_reqdata_len is set to the final request message size.
403 * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
405 int (*sign) (struct ptlrpc_cli_ctx *ctx,
406 struct ptlrpc_request *req);
409 * Verify the reply message using \a ctx.
411 * \pre req->rq_repdata point to reply message with signature.
412 * \pre req->rq_repdata_len is the total reply message length.
413 * \post req->rq_repmsg point to reply message without signature.
414 * \post req->rq_replen is the reply message length.
416 * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
418 int (*verify) (struct ptlrpc_cli_ctx *ctx,
419 struct ptlrpc_request *req);
422 * Encrypt the request message using \a ctx.
424 * \pre req->rq_reqmsg point to request message in clear text.
425 * \pre req->rq_reqlen is the request message length.
426 * \post req->rq_reqbuf point to request message.
427 * \post req->rq_reqdata_len is set to the final request message size.
429 * \see gss_cli_ctx_seal().
431 int (*seal) (struct ptlrpc_cli_ctx *ctx,
432 struct ptlrpc_request *req);
435 * Decrypt the reply message using \a ctx.
437 * \pre req->rq_repdata point to encrypted reply message.
438 * \pre req->rq_repdata_len is the total cipher text length.
439 * \post req->rq_repmsg point to reply message in clear text.
440 * \post req->rq_replen is the reply message length in clear text.
442 * \see gss_cli_ctx_unseal().
444 int (*unseal) (struct ptlrpc_cli_ctx *ctx,
445 struct ptlrpc_request *req);
448 * Wrap bulk request data. This is called before wrapping RPC
451 * \pre bulk buffer is descripted by desc->bd_iov and
452 * desc->bd_iov_count. note for read it's just buffer, no data
453 * need to be sent; for write it contains data in clear text.
454 * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
455 * (usually inside of RPC request message).
456 * - encryption: cipher text bulk buffer is descripted by
457 * desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
458 * count remains the same).
459 * - otherwise: bulk buffer is still desc->bd_iov and
460 * desc->bd_iov_count.
462 * \return 0: success.
463 * \return -ev: error code.
465 * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
467 int (*wrap_bulk) (struct ptlrpc_cli_ctx *ctx,
468 struct ptlrpc_request *req,
469 struct ptlrpc_bulk_desc *desc);
472 * Unwrap bulk reply data. This is called after wrapping RPC
475 * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
476 * desc->bd_iov_count, according to wrap_bulk().
477 * \post final bulk data in clear text is placed in buffer described
478 * by desc->bd_iov and desc->bd_iov_count.
479 * \return +ve nob of actual bulk data in clear text.
480 * \return -ve error code.
482 * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
484 int (*unwrap_bulk) (struct ptlrpc_cli_ctx *ctx,
485 struct ptlrpc_request *req,
486 struct ptlrpc_bulk_desc *desc);
489 #define PTLRPC_CTX_NEW_BIT (0) /* newly created */
490 #define PTLRPC_CTX_UPTODATE_BIT (1) /* uptodate */
491 #define PTLRPC_CTX_DEAD_BIT (2) /* mark expired gracefully */
492 #define PTLRPC_CTX_ERROR_BIT (3) /* fatal error (refresh, etc.) */
493 #define PTLRPC_CTX_CACHED_BIT (8) /* in ctx cache (hash etc.) */
494 #define PTLRPC_CTX_ETERNAL_BIT (9) /* always valid */
496 #define PTLRPC_CTX_NEW (1 << PTLRPC_CTX_NEW_BIT)
497 #define PTLRPC_CTX_UPTODATE (1 << PTLRPC_CTX_UPTODATE_BIT)
498 #define PTLRPC_CTX_DEAD (1 << PTLRPC_CTX_DEAD_BIT)
499 #define PTLRPC_CTX_ERROR (1 << PTLRPC_CTX_ERROR_BIT)
500 #define PTLRPC_CTX_CACHED (1 << PTLRPC_CTX_CACHED_BIT)
501 #define PTLRPC_CTX_ETERNAL (1 << PTLRPC_CTX_ETERNAL_BIT)
503 #define PTLRPC_CTX_STATUS_MASK (PTLRPC_CTX_NEW_BIT | \
504 PTLRPC_CTX_UPTODATE | \
508 struct ptlrpc_cli_ctx {
509 cfs_hlist_node_t cc_cache; /* linked into ctx cache */
510 cfs_atomic_t cc_refcount;
511 struct ptlrpc_sec *cc_sec;
512 struct ptlrpc_ctx_ops *cc_ops;
513 cfs_time_t cc_expire; /* in seconds */
514 unsigned int cc_early_expire:1;
515 unsigned long cc_flags;
516 struct vfs_cred cc_vcred;
518 cfs_list_t cc_req_list; /* waiting reqs linked here */
519 cfs_list_t cc_gc_chain; /* linked to gc chain */
523 * client side policy operation vector.
525 struct ptlrpc_sec_cops {
527 * Given an \a imp, create and initialize a ptlrpc_sec structure.
528 * \param ctx service context:
529 * - regular import: \a ctx should be NULL;
530 * - reverse import: \a ctx is obtained from incoming request.
531 * \param flavor specify what flavor to use.
533 * When necessary, policy module is responsible for taking reference
536 * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
538 struct ptlrpc_sec * (*create_sec) (struct obd_import *imp,
539 struct ptlrpc_svc_ctx *ctx,
540 struct sptlrpc_flavor *flavor);
543 * Destructor of ptlrpc_sec. When called, refcount has been dropped
544 * to 0 and all contexts has been destroyed.
546 * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
548 void (*destroy_sec) (struct ptlrpc_sec *sec);
551 * Notify that this ptlrpc_sec is going to die. Optionally, policy
552 * module is supposed to set sec->ps_dying and whatever necessary
555 * \see plain_kill_sec(), gss_sec_kill().
557 void (*kill_sec) (struct ptlrpc_sec *sec);
560 * Given \a vcred, lookup and/or create its context. The policy module
561 * is supposed to maintain its own context cache.
562 * XXX currently \a create and \a remove_dead is always 1, perhaps
563 * should be removed completely.
565 * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
567 struct ptlrpc_cli_ctx * (*lookup_ctx) (struct ptlrpc_sec *sec,
568 struct vfs_cred *vcred,
573 * Called then the reference of \a ctx dropped to 0. The policy module
574 * is supposed to destroy this context or whatever else according to
575 * its cache maintainance mechamism.
577 * \param sync if zero, we shouldn't wait for the context being
578 * destroyed completely.
580 * \see plain_release_ctx(), gss_sec_release_ctx_kr().
582 void (*release_ctx) (struct ptlrpc_sec *sec,
583 struct ptlrpc_cli_ctx *ctx,
587 * Flush the context cache.
589 * \param uid context of which user, -1 means all contexts.
590 * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
591 * contexts should be cleared immediately.
592 * \param force if zero, only idle contexts will be flushed.
594 * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
596 int (*flush_ctx_cache)
597 (struct ptlrpc_sec *sec,
603 * Called periodically by garbage collector to remove dead contexts
606 * \see gss_sec_gc_ctx_kr().
608 void (*gc_ctx) (struct ptlrpc_sec *sec);
611 * Given an context \a ctx, install a corresponding reverse service
612 * context on client side.
613 * XXX currently it's only used by GSS module, maybe we should remove
614 * this from general API.
616 int (*install_rctx)(struct obd_import *imp,
617 struct ptlrpc_sec *sec,
618 struct ptlrpc_cli_ctx *ctx);
621 * To allocate request buffer for \a req.
623 * \pre req->rq_reqmsg == NULL.
624 * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
625 * we are not supposed to free it.
626 * \post if success, req->rq_reqmsg point to a buffer with size
627 * at least \a lustre_msg_size.
629 * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
631 int (*alloc_reqbuf)(struct ptlrpc_sec *sec,
632 struct ptlrpc_request *req,
633 int lustre_msg_size);
636 * To free request buffer for \a req.
638 * \pre req->rq_reqbuf != NULL.
640 * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
642 void (*free_reqbuf) (struct ptlrpc_sec *sec,
643 struct ptlrpc_request *req);
646 * To allocate reply buffer for \a req.
648 * \pre req->rq_repbuf == NULL.
649 * \post if success, req->rq_repbuf point to a buffer with size
650 * req->rq_repbuf_len, the size should be large enough to receive
651 * reply which be transformed from \a lustre_msg_size of clear text.
653 * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
655 int (*alloc_repbuf)(struct ptlrpc_sec *sec,
656 struct ptlrpc_request *req,
657 int lustre_msg_size);
660 * To free reply buffer for \a req.
662 * \pre req->rq_repbuf != NULL.
663 * \post req->rq_repbuf == NULL.
664 * \post req->rq_repbuf_len == 0.
666 * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
668 void (*free_repbuf) (struct ptlrpc_sec *sec,
669 struct ptlrpc_request *req);
672 * To expand the request buffer of \a req, thus the \a segment in
673 * the request message pointed by req->rq_reqmsg can accommodate
674 * at least \a newsize of data.
676 * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
678 * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
679 * gss_enlarge_reqbuf().
681 int (*enlarge_reqbuf)
682 (struct ptlrpc_sec *sec,
683 struct ptlrpc_request *req,
684 int segment, int newsize);
688 int (*display) (struct ptlrpc_sec *sec,
689 struct seq_file *seq);
693 * server side policy operation vector.
695 struct ptlrpc_sec_sops {
697 * verify an incoming request.
699 * \pre request message is pointed by req->rq_reqbuf, size is
700 * req->rq_reqdata_len; and the message has been unpacked to
703 * \retval SECSVC_OK success, req->rq_reqmsg point to request message
704 * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
705 * req->rq_sp_from is decoded from request.
706 * \retval SECSVC_COMPLETE success, the request has been fully
707 * processed, and reply message has been prepared; req->rq_sp_from is
708 * decoded from request.
709 * \retval SECSVC_DROP failed, this request should be dropped.
711 * \see null_accept(), plain_accept(), gss_svc_accept_kr().
713 int (*accept) (struct ptlrpc_request *req);
716 * Perform security transformation upon reply message.
718 * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
720 * \post req->rs_repdata_len is the final message size.
721 * \post req->rq_reply_off is set.
723 * \see null_authorize(), plain_authorize(), gss_svc_authorize().
725 int (*authorize) (struct ptlrpc_request *req);
728 * Invalidate server context \a ctx.
730 * \see gss_svc_invalidate_ctx().
732 void (*invalidate_ctx)
733 (struct ptlrpc_svc_ctx *ctx);
736 * Allocate a ptlrpc_reply_state.
738 * \param msgsize size of the reply message in clear text.
739 * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
740 * should simply use it; otherwise we'll responsible for allocating
742 * \post req->rq_reply_state != NULL;
743 * \post req->rq_reply_state->rs_msg != NULL;
745 * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
747 int (*alloc_rs) (struct ptlrpc_request *req,
751 * Free a ptlrpc_reply_state.
753 void (*free_rs) (struct ptlrpc_reply_state *rs);
756 * Release the server context \a ctx.
758 * \see gss_svc_free_ctx().
760 void (*free_ctx) (struct ptlrpc_svc_ctx *ctx);
763 * Install a reverse context based on the server context \a ctx.
765 * \see gss_svc_install_rctx_kr().
767 int (*install_rctx)(struct obd_import *imp,
768 struct ptlrpc_svc_ctx *ctx);
771 * Prepare buffer for incoming bulk write.
773 * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
774 * intended to receive the write.
776 * \see gss_svc_prep_bulk().
778 int (*prep_bulk) (struct ptlrpc_request *req,
779 struct ptlrpc_bulk_desc *desc);
782 * Unwrap the bulk write data.
784 * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
786 int (*unwrap_bulk) (struct ptlrpc_request *req,
787 struct ptlrpc_bulk_desc *desc);
790 * Wrap the bulk read data.
792 * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
794 int (*wrap_bulk) (struct ptlrpc_request *req,
795 struct ptlrpc_bulk_desc *desc);
798 struct ptlrpc_sec_policy {
799 cfs_module_t *sp_owner;
801 __u16 sp_policy; /* policy number */
802 struct ptlrpc_sec_cops *sp_cops; /* client ops */
803 struct ptlrpc_sec_sops *sp_sops; /* server ops */
806 #define PTLRPC_SEC_FL_REVERSE 0x0001 /* reverse sec */
807 #define PTLRPC_SEC_FL_ROOTONLY 0x0002 /* treat everyone as root */
808 #define PTLRPC_SEC_FL_UDESC 0x0004 /* ship udesc */
809 #define PTLRPC_SEC_FL_BULK 0x0008 /* intensive bulk i/o expected */
810 #define PTLRPC_SEC_FL_PAG 0x0010 /* PAG mode */
813 * The ptlrpc_sec represents the client side ptlrpc security facilities,
814 * each obd_import (both regular and reverse import) must associate with
817 * \see sptlrpc_import_sec_adapt().
820 struct ptlrpc_sec_policy *ps_policy;
821 cfs_atomic_t ps_refcount;
822 /** statistic only */
823 cfs_atomic_t ps_nctx;
824 /** unique identifier */
826 struct sptlrpc_flavor ps_flvr;
827 enum lustre_sec_part ps_part;
828 /** after set, no more new context will be created */
829 unsigned int ps_dying:1;
831 struct obd_import *ps_import;
837 cfs_list_t ps_gc_list;
838 cfs_time_t ps_gc_interval; /* in seconds */
839 cfs_time_t ps_gc_next; /* in seconds */
842 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
844 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
847 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
849 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
853 struct ptlrpc_svc_ctx {
854 cfs_atomic_t sc_refcount;
855 struct ptlrpc_sec_policy *sc_policy;
859 * user identity descriptor
861 #define LUSTRE_MAX_GROUPS (128)
863 struct ptlrpc_user_desc {
876 enum sptlrpc_bulk_hash_alg {
877 BULK_HASH_ALG_NULL = 0,
878 BULK_HASH_ALG_ADLER32,
882 BULK_HASH_ALG_SHA256,
883 BULK_HASH_ALG_SHA384,
884 BULK_HASH_ALG_SHA512,
888 const char * sptlrpc_get_hash_name(__u8 hash_alg);
889 __u8 sptlrpc_get_hash_alg(const char *algname);
895 struct ptlrpc_bulk_sec_desc {
896 __u8 bsd_version; /* 0 */
897 __u8 bsd_type; /* SPTLRPC_BULK_XXX */
898 __u8 bsd_svc; /* SPTLRPC_BULK_SVC_XXXX */
899 __u8 bsd_flags; /* flags */
900 __u32 bsd_nob; /* nob of bulk data */
901 __u8 bsd_data[0]; /* policy-specific token */
908 struct proc_dir_entry;
909 extern struct proc_dir_entry *sptlrpc_proc_root;
912 * round size up to next power of 2, for slab allocation.
913 * @size must be sane (can't overflow after round up)
915 static inline int size_roundup_power2(int size)
928 * internal support libraries
930 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
931 int segment, int newsize);
936 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
937 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
939 __u32 sptlrpc_name2flavor_base(const char *name);
940 const char *sptlrpc_flavor2name_base(__u32 flvr);
941 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
942 char *buf, int bufsize);
943 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
944 char *sptlrpc_secflags2str(__u32 flags, char *buf, int bufsize);
947 struct ptlrpc_sec_policy *sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
949 __cfs_module_get(policy->sp_owner);
954 void sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
956 cfs_module_put(policy->sp_owner);
963 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
965 return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
969 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
971 return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
975 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
977 return (cli_ctx_status(ctx) != 0);
981 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
983 return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
987 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
989 return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
993 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
995 return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
999 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
1001 return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
1007 struct ptlrpc_sec *sptlrpc_sec_get(struct ptlrpc_sec *sec);
1008 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
1011 * internal apis which only used by policy impelentation
1013 int sptlrpc_get_next_secid(void);
1014 void sptlrpc_sec_destroy(struct ptlrpc_sec *sec);
1017 * exported client context api
1019 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
1020 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
1021 void sptlrpc_cli_ctx_expire(struct ptlrpc_cli_ctx *ctx);
1022 void sptlrpc_cli_ctx_wakeup(struct ptlrpc_cli_ctx *ctx);
1023 int sptlrpc_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
1026 * exported client context wrap/buffers
1028 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
1029 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
1030 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
1031 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
1032 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
1033 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
1034 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1035 int segment, int newsize);
1036 int sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1037 struct ptlrpc_request **req_ret);
1038 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
1040 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
1043 * exported higher interface of import & request
1045 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1046 struct ptlrpc_svc_ctx *ctx,
1047 struct sptlrpc_flavor *flvr);
1048 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
1049 void sptlrpc_import_sec_put(struct obd_import *imp);
1051 int sptlrpc_import_check_ctx(struct obd_import *imp);
1052 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
1053 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
1054 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
1055 int sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1056 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1057 int sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1058 int sptlrpc_req_replace_dead_ctx(struct ptlrpc_request *req);
1059 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1061 int sptlrpc_parse_rule(char *param, struct sptlrpc_rule *rule);
1064 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1065 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1066 void sptlrpc_gc_add_ctx(struct ptlrpc_cli_ctx *ctx);
1069 const char * sec2target_str(struct ptlrpc_sec *sec);
1070 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *dev);
1075 enum secsvc_accept_res {
1081 int sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1082 int sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1083 int sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1084 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1085 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1086 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1087 void sptlrpc_svc_ctx_invalidate(struct ptlrpc_request *req);
1089 int sptlrpc_target_export_check(struct obd_export *exp,
1090 struct ptlrpc_request *req);
1091 void sptlrpc_target_update_exp_flavor(struct obd_device *obd,
1092 struct sptlrpc_rule_set *rset);
1097 int sptlrpc_svc_install_rvs_ctx(struct obd_import *imp,
1098 struct ptlrpc_svc_ctx *ctx);
1099 int sptlrpc_cli_install_rvs_ctx(struct obd_import *imp,
1100 struct ptlrpc_cli_ctx *ctx);
1102 /* bulk security api */
1103 int sptlrpc_enc_pool_add_user(void);
1104 int sptlrpc_enc_pool_del_user(void);
1105 int sptlrpc_enc_pool_get_pages(struct ptlrpc_bulk_desc *desc);
1106 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1108 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1109 struct ptlrpc_bulk_desc *desc);
1110 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1111 struct ptlrpc_bulk_desc *desc,
1113 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1114 struct ptlrpc_bulk_desc *desc);
1115 #ifdef HAVE_SERVER_SUPPORT
1116 int sptlrpc_svc_prep_bulk(struct ptlrpc_request *req,
1117 struct ptlrpc_bulk_desc *desc);
1118 int sptlrpc_svc_wrap_bulk(struct ptlrpc_request *req,
1119 struct ptlrpc_bulk_desc *desc);
1120 int sptlrpc_svc_unwrap_bulk(struct ptlrpc_request *req,
1121 struct ptlrpc_bulk_desc *desc);
1124 /* bulk helpers (internal use only by policies) */
1125 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1126 void *buf, int buflen);
1128 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1130 /* user descriptor helpers */
1131 static inline int sptlrpc_user_desc_size(int ngroups)
1133 return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1136 int sptlrpc_current_user_desc_size(void);
1137 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1138 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1141 #define CFS_CAP_CHOWN_MASK (1 << CFS_CAP_CHOWN)
1142 #define CFS_CAP_SYS_RESOURCE_MASK (1 << CFS_CAP_SYS_RESOURCE)
1145 LUSTRE_SEC_NONE = 0,
1146 LUSTRE_SEC_REMOTE = 1,
1147 LUSTRE_SEC_SPECIFY = 2,
1153 #endif /* _LUSTRE_SEC_H_ */