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.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
35 #ifndef _LUSTRE_SEC_H_
36 #define _LUSTRE_SEC_H_
38 /** \defgroup sptlrpc sptlrpc
48 struct ptlrpc_request;
49 struct ptlrpc_reply_state;
50 struct ptlrpc_bulk_desc;
59 struct ptlrpc_sec_policy;
60 struct ptlrpc_sec_cops;
61 struct ptlrpc_sec_sops;
63 struct ptlrpc_svc_ctx;
64 struct ptlrpc_cli_ctx;
65 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_MAX,
107 enum sptlrpc_service_type {
108 SPTLRPC_SVC_NULL = 0, /**< no security */
109 SPTLRPC_SVC_AUTH = 1, /**< authentication only */
110 SPTLRPC_SVC_INTG = 2, /**< integrity */
111 SPTLRPC_SVC_PRIV = 3, /**< privacy */
115 enum sptlrpc_bulk_type {
116 SPTLRPC_BULK_DEFAULT = 0, /**< follow rpc flavor */
117 SPTLRPC_BULK_HASH = 1, /**< hash integrity */
121 enum sptlrpc_bulk_service {
122 SPTLRPC_BULK_SVC_NULL = 0, /**< no security */
123 SPTLRPC_BULK_SVC_AUTH = 1, /**< authentication only */
124 SPTLRPC_BULK_SVC_INTG = 2, /**< integrity */
125 SPTLRPC_BULK_SVC_PRIV = 3, /**< privacy */
126 SPTLRPC_BULK_SVC_MAX,
130 * compose/extract macros
132 #define FLVR_POLICY_OFFSET (0)
133 #define FLVR_MECH_OFFSET (4)
134 #define FLVR_SVC_OFFSET (8)
135 #define FLVR_BULK_TYPE_OFFSET (12)
136 #define FLVR_BULK_SVC_OFFSET (16)
138 #define MAKE_FLVR(policy, mech, svc, btype, bsvc) \
139 (((__u32)(policy) << FLVR_POLICY_OFFSET) | \
140 ((__u32)(mech) << FLVR_MECH_OFFSET) | \
141 ((__u32)(svc) << FLVR_SVC_OFFSET) | \
142 ((__u32)(btype) << FLVR_BULK_TYPE_OFFSET) | \
143 ((__u32)(bsvc) << FLVR_BULK_SVC_OFFSET))
148 #define SPTLRPC_FLVR_POLICY(flavor) \
149 ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xF)
150 #define SPTLRPC_FLVR_MECH(flavor) \
151 ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xF)
152 #define SPTLRPC_FLVR_SVC(flavor) \
153 ((((__u32)(flavor)) >> FLVR_SVC_OFFSET) & 0xF)
154 #define SPTLRPC_FLVR_BULK_TYPE(flavor) \
155 ((((__u32)(flavor)) >> FLVR_BULK_TYPE_OFFSET) & 0xF)
156 #define SPTLRPC_FLVR_BULK_SVC(flavor) \
157 ((((__u32)(flavor)) >> FLVR_BULK_SVC_OFFSET) & 0xF)
159 #define SPTLRPC_FLVR_BASE(flavor) \
160 ((((__u32)(flavor)) >> FLVR_POLICY_OFFSET) & 0xFFF)
161 #define SPTLRPC_FLVR_BASE_SUB(flavor) \
162 ((((__u32)(flavor)) >> FLVR_MECH_OFFSET) & 0xFF)
167 #define MAKE_BASE_SUBFLVR(mech, svc) \
169 ((__u32)(svc) << (FLVR_SVC_OFFSET - FLVR_MECH_OFFSET)))
171 #define SPTLRPC_SUBFLVR_KRB5N \
172 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_NULL)
173 #define SPTLRPC_SUBFLVR_KRB5A \
174 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_AUTH)
175 #define SPTLRPC_SUBFLVR_KRB5I \
176 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_INTG)
177 #define SPTLRPC_SUBFLVR_KRB5P \
178 MAKE_BASE_SUBFLVR(SPTLRPC_MECH_GSS_KRB5, SPTLRPC_SVC_PRIV)
183 #define SPTLRPC_FLVR_NULL \
184 MAKE_FLVR(SPTLRPC_POLICY_NULL, \
187 SPTLRPC_BULK_DEFAULT, \
188 SPTLRPC_BULK_SVC_NULL)
189 #define SPTLRPC_FLVR_PLAIN \
190 MAKE_FLVR(SPTLRPC_POLICY_PLAIN, \
191 SPTLRPC_MECH_PLAIN, \
194 SPTLRPC_BULK_SVC_INTG)
195 #define SPTLRPC_FLVR_KRB5N \
196 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
197 SPTLRPC_MECH_GSS_KRB5, \
199 SPTLRPC_BULK_DEFAULT, \
200 SPTLRPC_BULK_SVC_NULL)
201 #define SPTLRPC_FLVR_KRB5A \
202 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
203 SPTLRPC_MECH_GSS_KRB5, \
205 SPTLRPC_BULK_DEFAULT, \
206 SPTLRPC_BULK_SVC_NULL)
207 #define SPTLRPC_FLVR_KRB5I \
208 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
209 SPTLRPC_MECH_GSS_KRB5, \
211 SPTLRPC_BULK_DEFAULT, \
212 SPTLRPC_BULK_SVC_INTG)
213 #define SPTLRPC_FLVR_KRB5P \
214 MAKE_FLVR(SPTLRPC_POLICY_GSS, \
215 SPTLRPC_MECH_GSS_KRB5, \
217 SPTLRPC_BULK_DEFAULT, \
218 SPTLRPC_BULK_SVC_PRIV)
220 #define SPTLRPC_FLVR_DEFAULT SPTLRPC_FLVR_NULL
222 #define SPTLRPC_FLVR_INVALID ((__u32) 0xFFFFFFFF)
223 #define SPTLRPC_FLVR_ANY ((__u32) 0xFFF00000)
226 * extract the useful part from wire flavor
228 #define WIRE_FLVR(wflvr) (((__u32) (wflvr)) & 0x000FFFFF)
232 static inline void flvr_set_svc(__u32 *flvr, __u32 svc)
234 LASSERT(svc < SPTLRPC_SVC_MAX);
235 *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
236 SPTLRPC_FLVR_MECH(*flvr),
238 SPTLRPC_FLVR_BULK_TYPE(*flvr),
239 SPTLRPC_FLVR_BULK_SVC(*flvr));
242 static inline void flvr_set_bulk_svc(__u32 *flvr, __u32 svc)
244 LASSERT(svc < SPTLRPC_BULK_SVC_MAX);
245 *flvr = MAKE_FLVR(SPTLRPC_FLVR_POLICY(*flvr),
246 SPTLRPC_FLVR_MECH(*flvr),
247 SPTLRPC_FLVR_SVC(*flvr),
248 SPTLRPC_FLVR_BULK_TYPE(*flvr),
252 struct bulk_spec_hash {
257 * Full description of flavors being used on a ptlrpc connection, include
258 * both regular RPC and bulk transfer parts.
260 struct sptlrpc_flavor {
262 * wire flavor, should be renamed to sf_wire.
266 * general flags of PTLRPC_SEC_FL_*
270 * rpc flavor specification
273 /* nothing for now */
276 * bulk flavor specification
279 struct bulk_spec_hash hash;
284 * identify the RPC is generated from what part of Lustre. It's encoded into
285 * RPC requests and to be checked by ptlrpc service.
287 enum lustre_sec_part {
296 const char *sptlrpc_part2name(enum lustre_sec_part sp);
297 enum lustre_sec_part sptlrpc_target_sec_part(struct obd_device *obd);
300 * A rule specifies a flavor to be used by a ptlrpc connection between
303 struct sptlrpc_rule {
304 __u32 sr_netid; /* LNET network ID */
305 __u8 sr_from; /* sec_part */
306 __u8 sr_to; /* sec_part */
308 struct sptlrpc_flavor sr_flvr;
312 * A set of rules in memory.
314 * Rules are generated and stored on MGS, and propagated to MDT, OST,
315 * and client when needed.
317 struct sptlrpc_rule_set {
320 struct sptlrpc_rule *srs_rules;
323 int sptlrpc_parse_flavor(const char *str, struct sptlrpc_flavor *flvr);
324 int sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr);
326 static inline void sptlrpc_rule_set_init(struct sptlrpc_rule_set *set)
328 memset(set, 0, sizeof(*set));
331 void sptlrpc_rule_set_free(struct sptlrpc_rule_set *set);
332 int sptlrpc_rule_set_expand(struct sptlrpc_rule_set *set);
333 int sptlrpc_rule_set_merge(struct sptlrpc_rule_set *set,
334 struct sptlrpc_rule *rule);
335 int sptlrpc_rule_set_choose(struct sptlrpc_rule_set *rset,
336 enum lustre_sec_part from,
337 enum lustre_sec_part to,
339 struct sptlrpc_flavor *sf);
340 void sptlrpc_rule_set_dump(struct sptlrpc_rule_set *set);
342 int sptlrpc_process_config(struct lustre_cfg *lcfg);
343 void sptlrpc_conf_log_start(const char *logname);
344 void sptlrpc_conf_log_stop(const char *logname);
345 void sptlrpc_conf_log_update_begin(const char *logname);
346 void sptlrpc_conf_log_update_end(const char *logname);
347 void sptlrpc_conf_client_adapt(struct obd_device *obd);
348 int sptlrpc_conf_target_get_rules(struct obd_device *obd,
349 struct sptlrpc_rule_set *rset,
351 void sptlrpc_target_choose_flavor(struct sptlrpc_rule_set *rset,
352 enum lustre_sec_part from,
354 struct sptlrpc_flavor *flavor);
356 /* The maximum length of security payload. 1024 is enough for Kerberos 5,
357 * and should be enough for other future mechanisms but not sure.
358 * Only used by pre-allocated request/reply pool.
360 #define SPTLRPC_MAX_PAYLOAD (1024)
368 struct ptlrpc_ctx_ops {
370 * To determine whether it's suitable to use the \a ctx for \a vcred.
372 int (*match) (struct ptlrpc_cli_ctx *ctx,
373 struct vfs_cred *vcred);
376 * To bring the \a ctx uptodate.
378 int (*refresh) (struct ptlrpc_cli_ctx *ctx);
381 * Validate the \a ctx.
383 int (*validate) (struct ptlrpc_cli_ctx *ctx);
386 * Force the \a ctx to die.
388 void (*die) (struct ptlrpc_cli_ctx *ctx,
390 int (*display) (struct ptlrpc_cli_ctx *ctx,
391 char *buf, int bufsize);
394 * Sign the request message using \a ctx.
396 * \pre req->rq_reqmsg point to request message.
397 * \pre req->rq_reqlen is the request message length.
398 * \post req->rq_reqbuf point to request message with signature.
399 * \post req->rq_reqdata_len is set to the final request message size.
401 * \see null_ctx_sign(), plain_ctx_sign(), gss_cli_ctx_sign().
403 int (*sign) (struct ptlrpc_cli_ctx *ctx,
404 struct ptlrpc_request *req);
407 * Verify the reply message using \a ctx.
409 * \pre req->rq_repdata point to reply message with signature.
410 * \pre req->rq_repdata_len is the total reply message length.
411 * \post req->rq_repmsg point to reply message without signature.
412 * \post req->rq_replen is the reply message length.
414 * \see null_ctx_verify(), plain_ctx_verify(), gss_cli_ctx_verify().
416 int (*verify) (struct ptlrpc_cli_ctx *ctx,
417 struct ptlrpc_request *req);
420 * Encrypt the request message using \a ctx.
422 * \pre req->rq_reqmsg point to request message in clear text.
423 * \pre req->rq_reqlen is the request message length.
424 * \post req->rq_reqbuf point to request message.
425 * \post req->rq_reqdata_len is set to the final request message size.
427 * \see gss_cli_ctx_seal().
429 int (*seal) (struct ptlrpc_cli_ctx *ctx,
430 struct ptlrpc_request *req);
433 * Decrypt the reply message using \a ctx.
435 * \pre req->rq_repdata point to encrypted reply message.
436 * \pre req->rq_repdata_len is the total cipher text length.
437 * \post req->rq_repmsg point to reply message in clear text.
438 * \post req->rq_replen is the reply message length in clear text.
440 * \see gss_cli_ctx_unseal().
442 int (*unseal) (struct ptlrpc_cli_ctx *ctx,
443 struct ptlrpc_request *req);
446 * Wrap bulk request data. This is called before wrapping RPC
449 * \pre bulk buffer is descripted by desc->bd_iov and
450 * desc->bd_iov_count. note for read it's just buffer, no data
451 * need to be sent; for write it contains data in clear text.
452 * \post when necessary, ptlrpc_bulk_sec_desc was properly prepared
453 * (usually inside of RPC request message).
454 * - encryption: cipher text bulk buffer is descripted by
455 * desc->bd_enc_iov and desc->bd_iov_count (currently assume iov
456 * count remains the same).
457 * - otherwise: bulk buffer is still desc->bd_iov and
458 * desc->bd_iov_count.
460 * \return 0: success.
461 * \return -ev: error code.
463 * \see plain_cli_wrap_bulk(), gss_cli_ctx_wrap_bulk().
465 int (*wrap_bulk) (struct ptlrpc_cli_ctx *ctx,
466 struct ptlrpc_request *req,
467 struct ptlrpc_bulk_desc *desc);
470 * Unwrap bulk reply data. This is called after wrapping RPC
473 * \pre bulk buffer is descripted by desc->bd_iov/desc->bd_enc_iov and
474 * desc->bd_iov_count, according to wrap_bulk().
475 * \post final bulk data in clear text is placed in buffer described
476 * by desc->bd_iov and desc->bd_iov_count.
477 * \return +ve nob of actual bulk data in clear text.
478 * \return -ve error code.
480 * \see plain_cli_unwrap_bulk(), gss_cli_ctx_unwrap_bulk().
482 int (*unwrap_bulk) (struct ptlrpc_cli_ctx *ctx,
483 struct ptlrpc_request *req,
484 struct ptlrpc_bulk_desc *desc);
487 #define PTLRPC_CTX_NEW_BIT (0) /* newly created */
488 #define PTLRPC_CTX_UPTODATE_BIT (1) /* uptodate */
489 #define PTLRPC_CTX_DEAD_BIT (2) /* mark expired gracefully */
490 #define PTLRPC_CTX_ERROR_BIT (3) /* fatal error (refresh, etc.) */
491 #define PTLRPC_CTX_CACHED_BIT (8) /* in ctx cache (hash etc.) */
492 #define PTLRPC_CTX_ETERNAL_BIT (9) /* always valid */
494 #define PTLRPC_CTX_NEW (1 << PTLRPC_CTX_NEW_BIT)
495 #define PTLRPC_CTX_UPTODATE (1 << PTLRPC_CTX_UPTODATE_BIT)
496 #define PTLRPC_CTX_DEAD (1 << PTLRPC_CTX_DEAD_BIT)
497 #define PTLRPC_CTX_ERROR (1 << PTLRPC_CTX_ERROR_BIT)
498 #define PTLRPC_CTX_CACHED (1 << PTLRPC_CTX_CACHED_BIT)
499 #define PTLRPC_CTX_ETERNAL (1 << PTLRPC_CTX_ETERNAL_BIT)
501 #define PTLRPC_CTX_STATUS_MASK (PTLRPC_CTX_NEW_BIT | \
502 PTLRPC_CTX_UPTODATE | \
506 struct ptlrpc_cli_ctx {
507 cfs_hlist_node_t cc_cache; /* linked into ctx cache */
508 cfs_atomic_t cc_refcount;
509 struct ptlrpc_sec *cc_sec;
510 struct ptlrpc_ctx_ops *cc_ops;
511 cfs_time_t cc_expire; /* in seconds */
512 unsigned int cc_early_expire:1;
513 unsigned long cc_flags;
514 struct vfs_cred cc_vcred;
515 cfs_spinlock_t cc_lock;
516 cfs_list_t cc_req_list; /* waiting reqs linked here */
517 cfs_list_t cc_gc_chain; /* linked to gc chain */
521 * client side policy operation vector.
523 struct ptlrpc_sec_cops {
525 * Given an \a imp, create and initialize a ptlrpc_sec structure.
526 * \param ctx service context:
527 * - regular import: \a ctx should be NULL;
528 * - reverse import: \a ctx is obtained from incoming request.
529 * \param flavor specify what flavor to use.
531 * When necessary, policy module is responsible for taking reference
534 * \see null_create_sec(), plain_create_sec(), gss_sec_create_kr().
536 struct ptlrpc_sec * (*create_sec) (struct obd_import *imp,
537 struct ptlrpc_svc_ctx *ctx,
538 struct sptlrpc_flavor *flavor);
541 * Destructor of ptlrpc_sec. When called, refcount has been dropped
542 * to 0 and all contexts has been destroyed.
544 * \see null_destroy_sec(), plain_destroy_sec(), gss_sec_destroy_kr().
546 void (*destroy_sec) (struct ptlrpc_sec *sec);
549 * Notify that this ptlrpc_sec is going to die. Optionally, policy
550 * module is supposed to set sec->ps_dying and whatever necessary
553 * \see plain_kill_sec(), gss_sec_kill().
555 void (*kill_sec) (struct ptlrpc_sec *sec);
558 * Given \a vcred, lookup and/or create its context. The policy module
559 * is supposed to maintain its own context cache.
560 * XXX currently \a create and \a remove_dead is always 1, perhaps
561 * should be removed completely.
563 * \see null_lookup_ctx(), plain_lookup_ctx(), gss_sec_lookup_ctx_kr().
565 struct ptlrpc_cli_ctx * (*lookup_ctx) (struct ptlrpc_sec *sec,
566 struct vfs_cred *vcred,
571 * Called then the reference of \a ctx dropped to 0. The policy module
572 * is supposed to destroy this context or whatever else according to
573 * its cache maintainance mechamism.
575 * \param sync if zero, we shouldn't wait for the context being
576 * destroyed completely.
578 * \see plain_release_ctx(), gss_sec_release_ctx_kr().
580 void (*release_ctx) (struct ptlrpc_sec *sec,
581 struct ptlrpc_cli_ctx *ctx,
585 * Flush the context cache.
587 * \param uid context of which user, -1 means all contexts.
588 * \param grace if zero, the PTLRPC_CTX_UPTODATE_BIT of affected
589 * contexts should be cleared immediately.
590 * \param force if zero, only idle contexts will be flushed.
592 * \see plain_flush_ctx_cache(), gss_sec_flush_ctx_cache_kr().
594 int (*flush_ctx_cache)
595 (struct ptlrpc_sec *sec,
601 * Called periodically by garbage collector to remove dead contexts
604 * \see gss_sec_gc_ctx_kr().
606 void (*gc_ctx) (struct ptlrpc_sec *sec);
609 * Given an context \a ctx, install a corresponding reverse service
610 * context on client side.
611 * XXX currently it's only used by GSS module, maybe we should remove
612 * this from general API.
614 int (*install_rctx)(struct obd_import *imp,
615 struct ptlrpc_sec *sec,
616 struct ptlrpc_cli_ctx *ctx);
619 * To allocate request buffer for \a req.
621 * \pre req->rq_reqmsg == NULL.
622 * \pre req->rq_reqbuf == NULL, otherwise it must be pre-allocated,
623 * we are not supposed to free it.
624 * \post if success, req->rq_reqmsg point to a buffer with size
625 * at least \a lustre_msg_size.
627 * \see null_alloc_reqbuf(), plain_alloc_reqbuf(), gss_alloc_reqbuf().
629 int (*alloc_reqbuf)(struct ptlrpc_sec *sec,
630 struct ptlrpc_request *req,
631 int lustre_msg_size);
634 * To free request buffer for \a req.
636 * \pre req->rq_reqbuf != NULL.
638 * \see null_free_reqbuf(), plain_free_reqbuf(), gss_free_reqbuf().
640 void (*free_reqbuf) (struct ptlrpc_sec *sec,
641 struct ptlrpc_request *req);
644 * To allocate reply buffer for \a req.
646 * \pre req->rq_repbuf == NULL.
647 * \post if success, req->rq_repbuf point to a buffer with size
648 * req->rq_repbuf_len, the size should be large enough to receive
649 * reply which be transformed from \a lustre_msg_size of clear text.
651 * \see null_alloc_repbuf(), plain_alloc_repbuf(), gss_alloc_repbuf().
653 int (*alloc_repbuf)(struct ptlrpc_sec *sec,
654 struct ptlrpc_request *req,
655 int lustre_msg_size);
658 * To free reply buffer for \a req.
660 * \pre req->rq_repbuf != NULL.
661 * \post req->rq_repbuf == NULL.
662 * \post req->rq_repbuf_len == 0.
664 * \see null_free_repbuf(), plain_free_repbuf(), gss_free_repbuf().
666 void (*free_repbuf) (struct ptlrpc_sec *sec,
667 struct ptlrpc_request *req);
670 * To expand the request buffer of \a req, thus the \a segment in
671 * the request message pointed by req->rq_reqmsg can accommodate
672 * at least \a newsize of data.
674 * \pre req->rq_reqmsg->lm_buflens[segment] < newsize.
676 * \see null_enlarge_reqbuf(), plain_enlarge_reqbuf(),
677 * gss_enlarge_reqbuf().
679 int (*enlarge_reqbuf)
680 (struct ptlrpc_sec *sec,
681 struct ptlrpc_request *req,
682 int segment, int newsize);
686 int (*display) (struct ptlrpc_sec *sec,
687 struct seq_file *seq);
691 * server side policy operation vector.
693 struct ptlrpc_sec_sops {
695 * verify an incoming request.
697 * \pre request message is pointed by req->rq_reqbuf, size is
698 * req->rq_reqdata_len; and the message has been unpacked to
701 * \retval SECSVC_OK success, req->rq_reqmsg point to request message
702 * in clear text, size is req->rq_reqlen; req->rq_svc_ctx is set;
703 * req->rq_sp_from is decoded from request.
704 * \retval SECSVC_COMPLETE success, the request has been fully
705 * processed, and reply message has been prepared; req->rq_sp_from is
706 * decoded from request.
707 * \retval SECSVC_DROP failed, this request should be dropped.
709 * \see null_accept(), plain_accept(), gss_svc_accept_kr().
711 int (*accept) (struct ptlrpc_request *req);
714 * Perform security transformation upon reply message.
716 * \pre reply message is pointed by req->rq_reply_state->rs_msg, size
718 * \post req->rs_repdata_len is the final message size.
719 * \post req->rq_reply_off is set.
721 * \see null_authorize(), plain_authorize(), gss_svc_authorize().
723 int (*authorize) (struct ptlrpc_request *req);
726 * Invalidate server context \a ctx.
728 * \see gss_svc_invalidate_ctx().
730 void (*invalidate_ctx)
731 (struct ptlrpc_svc_ctx *ctx);
734 * Allocate a ptlrpc_reply_state.
736 * \param msgsize size of the reply message in clear text.
737 * \pre if req->rq_reply_state != NULL, then it's pre-allocated, we
738 * should simply use it; otherwise we'll responsible for allocating
740 * \post req->rq_reply_state != NULL;
741 * \post req->rq_reply_state->rs_msg != NULL;
743 * \see null_alloc_rs(), plain_alloc_rs(), gss_svc_alloc_rs().
745 int (*alloc_rs) (struct ptlrpc_request *req,
749 * Free a ptlrpc_reply_state.
751 void (*free_rs) (struct ptlrpc_reply_state *rs);
754 * Release the server context \a ctx.
756 * \see gss_svc_free_ctx().
758 void (*free_ctx) (struct ptlrpc_svc_ctx *ctx);
761 * Install a reverse context based on the server context \a ctx.
763 * \see gss_svc_install_rctx_kr().
765 int (*install_rctx)(struct obd_import *imp,
766 struct ptlrpc_svc_ctx *ctx);
769 * Prepare buffer for incoming bulk write.
771 * \pre desc->bd_iov and desc->bd_iov_count describes the buffer
772 * intended to receive the write.
774 * \see gss_svc_prep_bulk().
776 int (*prep_bulk) (struct ptlrpc_request *req,
777 struct ptlrpc_bulk_desc *desc);
780 * Unwrap the bulk write data.
782 * \see plain_svc_unwrap_bulk(), gss_svc_unwrap_bulk().
784 int (*unwrap_bulk) (struct ptlrpc_request *req,
785 struct ptlrpc_bulk_desc *desc);
788 * Wrap the bulk read data.
790 * \see plain_svc_wrap_bulk(), gss_svc_wrap_bulk().
792 int (*wrap_bulk) (struct ptlrpc_request *req,
793 struct ptlrpc_bulk_desc *desc);
796 struct ptlrpc_sec_policy {
797 cfs_module_t *sp_owner;
799 __u16 sp_policy; /* policy number */
800 struct ptlrpc_sec_cops *sp_cops; /* client ops */
801 struct ptlrpc_sec_sops *sp_sops; /* server ops */
804 #define PTLRPC_SEC_FL_REVERSE 0x0001 /* reverse sec */
805 #define PTLRPC_SEC_FL_ROOTONLY 0x0002 /* treat everyone as root */
806 #define PTLRPC_SEC_FL_UDESC 0x0004 /* ship udesc */
807 #define PTLRPC_SEC_FL_BULK 0x0008 /* intensive bulk i/o expected */
808 #define PTLRPC_SEC_FL_PAG 0x0010 /* PAG mode */
811 * The ptlrpc_sec represents the client side ptlrpc security facilities,
812 * each obd_import (both regular and reverse import) must associate with
815 * \see sptlrpc_import_sec_adapt().
818 struct ptlrpc_sec_policy *ps_policy;
819 cfs_atomic_t ps_refcount;
820 /** statistic only */
821 cfs_atomic_t ps_nctx;
822 /** unique identifier */
824 struct sptlrpc_flavor ps_flvr;
825 enum lustre_sec_part ps_part;
826 /** after set, no more new context will be created */
827 unsigned int ps_dying:1;
829 struct obd_import *ps_import;
830 cfs_spinlock_t ps_lock;
835 cfs_list_t ps_gc_list;
836 cfs_time_t ps_gc_interval; /* in seconds */
837 cfs_time_t ps_gc_next; /* in seconds */
840 static inline int sec_is_reverse(struct ptlrpc_sec *sec)
842 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE);
845 static inline int sec_is_rootonly(struct ptlrpc_sec *sec)
847 return (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_ROOTONLY);
851 struct ptlrpc_svc_ctx {
852 cfs_atomic_t sc_refcount;
853 struct ptlrpc_sec_policy *sc_policy;
857 * user identity descriptor
859 #define LUSTRE_MAX_GROUPS (128)
861 struct ptlrpc_user_desc {
874 enum sptlrpc_bulk_hash_alg {
875 BULK_HASH_ALG_NULL = 0,
876 BULK_HASH_ALG_ADLER32,
880 BULK_HASH_ALG_SHA256,
881 BULK_HASH_ALG_SHA384,
882 BULK_HASH_ALG_SHA512,
886 const char * sptlrpc_get_hash_name(__u8 hash_alg);
887 __u8 sptlrpc_get_hash_alg(const char *algname);
893 struct ptlrpc_bulk_sec_desc {
894 __u8 bsd_version; /* 0 */
895 __u8 bsd_type; /* SPTLRPC_BULK_XXX */
896 __u8 bsd_svc; /* SPTLRPC_BULK_SVC_XXXX */
897 __u8 bsd_flags; /* flags */
898 __u32 bsd_nob; /* nob of bulk data */
899 __u8 bsd_data[0]; /* policy-specific token */
906 struct proc_dir_entry;
907 extern struct proc_dir_entry *sptlrpc_proc_root;
910 * round size up to next power of 2, for slab allocation.
911 * @size must be sane (can't overflow after round up)
913 static inline int size_roundup_power2(int size)
926 * internal support libraries
928 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
929 int segment, int newsize);
934 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy);
935 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy);
937 __u32 sptlrpc_name2flavor_base(const char *name);
938 const char *sptlrpc_flavor2name_base(__u32 flvr);
939 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
940 char *buf, int bufsize);
941 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize);
942 char *sptlrpc_secflags2str(__u32 flags, char *buf, int bufsize);
945 struct ptlrpc_sec_policy *sptlrpc_policy_get(struct ptlrpc_sec_policy *policy)
947 __cfs_module_get(policy->sp_owner);
952 void sptlrpc_policy_put(struct ptlrpc_sec_policy *policy)
954 cfs_module_put(policy->sp_owner);
961 unsigned long cli_ctx_status(struct ptlrpc_cli_ctx *ctx)
963 return (ctx->cc_flags & PTLRPC_CTX_STATUS_MASK);
967 int cli_ctx_is_ready(struct ptlrpc_cli_ctx *ctx)
969 return (cli_ctx_status(ctx) == PTLRPC_CTX_UPTODATE);
973 int cli_ctx_is_refreshed(struct ptlrpc_cli_ctx *ctx)
975 return (cli_ctx_status(ctx) != 0);
979 int cli_ctx_is_uptodate(struct ptlrpc_cli_ctx *ctx)
981 return ((ctx->cc_flags & PTLRPC_CTX_UPTODATE) != 0);
985 int cli_ctx_is_error(struct ptlrpc_cli_ctx *ctx)
987 return ((ctx->cc_flags & PTLRPC_CTX_ERROR) != 0);
991 int cli_ctx_is_dead(struct ptlrpc_cli_ctx *ctx)
993 return ((ctx->cc_flags & (PTLRPC_CTX_DEAD | PTLRPC_CTX_ERROR)) != 0);
997 int cli_ctx_is_eternal(struct ptlrpc_cli_ctx *ctx)
999 return ((ctx->cc_flags & PTLRPC_CTX_ETERNAL) != 0);
1005 struct ptlrpc_sec *sptlrpc_sec_get(struct ptlrpc_sec *sec);
1006 void sptlrpc_sec_put(struct ptlrpc_sec *sec);
1009 * internal apis which only used by policy impelentation
1011 int sptlrpc_get_next_secid(void);
1012 void sptlrpc_sec_destroy(struct ptlrpc_sec *sec);
1015 * exported client context api
1017 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx);
1018 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync);
1019 void sptlrpc_cli_ctx_expire(struct ptlrpc_cli_ctx *ctx);
1020 void sptlrpc_cli_ctx_wakeup(struct ptlrpc_cli_ctx *ctx);
1021 int sptlrpc_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize);
1024 * exported client context wrap/buffers
1026 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req);
1027 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req);
1028 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize);
1029 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req);
1030 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize);
1031 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req);
1032 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1033 int segment, int newsize);
1034 int sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1035 struct ptlrpc_request **req_ret);
1036 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req);
1038 void sptlrpc_request_out_callback(struct ptlrpc_request *req);
1041 * exported higher interface of import & request
1043 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1044 struct ptlrpc_svc_ctx *ctx,
1045 struct sptlrpc_flavor *flvr);
1046 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp);
1047 void sptlrpc_import_sec_put(struct obd_import *imp);
1049 int sptlrpc_import_check_ctx(struct obd_import *imp);
1050 void sptlrpc_import_flush_root_ctx(struct obd_import *imp);
1051 void sptlrpc_import_flush_my_ctx(struct obd_import *imp);
1052 void sptlrpc_import_flush_all_ctx(struct obd_import *imp);
1053 int sptlrpc_req_get_ctx(struct ptlrpc_request *req);
1054 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync);
1055 int sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout);
1056 int sptlrpc_req_replace_dead_ctx(struct ptlrpc_request *req);
1057 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode);
1059 int sptlrpc_parse_rule(char *param, struct sptlrpc_rule *rule);
1062 void sptlrpc_gc_add_sec(struct ptlrpc_sec *sec);
1063 void sptlrpc_gc_del_sec(struct ptlrpc_sec *sec);
1064 void sptlrpc_gc_add_ctx(struct ptlrpc_cli_ctx *ctx);
1067 const char * sec2target_str(struct ptlrpc_sec *sec);
1068 int sptlrpc_lprocfs_cliobd_attach(struct obd_device *dev);
1073 enum secsvc_accept_res {
1079 int sptlrpc_svc_unwrap_request(struct ptlrpc_request *req);
1080 int sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen);
1081 int sptlrpc_svc_wrap_reply(struct ptlrpc_request *req);
1082 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs);
1083 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req);
1084 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req);
1085 void sptlrpc_svc_ctx_invalidate(struct ptlrpc_request *req);
1087 int sptlrpc_target_export_check(struct obd_export *exp,
1088 struct ptlrpc_request *req);
1089 void sptlrpc_target_update_exp_flavor(struct obd_device *obd,
1090 struct sptlrpc_rule_set *rset);
1095 int sptlrpc_svc_install_rvs_ctx(struct obd_import *imp,
1096 struct ptlrpc_svc_ctx *ctx);
1097 int sptlrpc_cli_install_rvs_ctx(struct obd_import *imp,
1098 struct ptlrpc_cli_ctx *ctx);
1100 /* bulk security api */
1101 int sptlrpc_enc_pool_add_user(void);
1102 int sptlrpc_enc_pool_del_user(void);
1103 int sptlrpc_enc_pool_get_pages(struct ptlrpc_bulk_desc *desc);
1104 void sptlrpc_enc_pool_put_pages(struct ptlrpc_bulk_desc *desc);
1106 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
1107 struct ptlrpc_bulk_desc *desc);
1108 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
1109 struct ptlrpc_bulk_desc *desc,
1111 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
1112 struct ptlrpc_bulk_desc *desc);
1113 #ifdef HAVE_SERVER_SUPPORT
1114 int sptlrpc_svc_prep_bulk(struct ptlrpc_request *req,
1115 struct ptlrpc_bulk_desc *desc);
1116 int sptlrpc_svc_wrap_bulk(struct ptlrpc_request *req,
1117 struct ptlrpc_bulk_desc *desc);
1118 int sptlrpc_svc_unwrap_bulk(struct ptlrpc_request *req,
1119 struct ptlrpc_bulk_desc *desc);
1122 /* bulk helpers (internal use only by policies) */
1123 int sptlrpc_get_bulk_checksum(struct ptlrpc_bulk_desc *desc, __u8 alg,
1124 void *buf, int buflen);
1126 int bulk_sec_desc_unpack(struct lustre_msg *msg, int offset, int swabbed);
1128 /* user descriptor helpers */
1129 static inline int sptlrpc_user_desc_size(int ngroups)
1131 return sizeof(struct ptlrpc_user_desc) + ngroups * sizeof(__u32);
1134 int sptlrpc_current_user_desc_size(void);
1135 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset);
1136 int sptlrpc_unpack_user_desc(struct lustre_msg *req, int offset, int swabbed);
1139 #define CFS_CAP_CHOWN_MASK (1 << CFS_CAP_CHOWN)
1140 #define CFS_CAP_SYS_RESOURCE_MASK (1 << CFS_CAP_SYS_RESOURCE)
1143 LUSTRE_SEC_NONE = 0,
1144 LUSTRE_SEC_REMOTE = 1,
1145 LUSTRE_SEC_SPECIFY = 2,
1151 #endif /* _LUSTRE_SEC_H_ */