1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Author: Eric Mei <ericm@clusterfs.com>
44 #define DEBUG_SUBSYSTEM S_SEC
46 #include <libcfs/libcfs.h>
48 #include <liblustre.h>
49 #include <libcfs/list.h>
51 #include <linux/crypto.h>
52 #include <linux/key.h>
56 #include <obd_class.h>
57 #include <obd_support.h>
58 #include <lustre_net.h>
59 #include <lustre_import.h>
60 #include <lustre_dlm.h>
61 #include <lustre_sec.h>
63 #include "ptlrpc_internal.h"
65 /***********************************************
67 ***********************************************/
69 static cfs_rwlock_t policy_lock;
70 static struct ptlrpc_sec_policy *policies[SPTLRPC_POLICY_MAX] = {
74 int sptlrpc_register_policy(struct ptlrpc_sec_policy *policy)
76 __u16 number = policy->sp_policy;
78 LASSERT(policy->sp_name);
79 LASSERT(policy->sp_cops);
80 LASSERT(policy->sp_sops);
82 if (number >= SPTLRPC_POLICY_MAX)
85 cfs_write_lock(&policy_lock);
86 if (unlikely(policies[number])) {
87 cfs_write_unlock(&policy_lock);
90 policies[number] = policy;
91 cfs_write_unlock(&policy_lock);
93 CDEBUG(D_SEC, "%s: registered\n", policy->sp_name);
96 EXPORT_SYMBOL(sptlrpc_register_policy);
98 int sptlrpc_unregister_policy(struct ptlrpc_sec_policy *policy)
100 __u16 number = policy->sp_policy;
102 LASSERT(number < SPTLRPC_POLICY_MAX);
104 cfs_write_lock(&policy_lock);
105 if (unlikely(policies[number] == NULL)) {
106 cfs_write_unlock(&policy_lock);
107 CERROR("%s: already unregistered\n", policy->sp_name);
111 LASSERT(policies[number] == policy);
112 policies[number] = NULL;
113 cfs_write_unlock(&policy_lock);
115 CDEBUG(D_SEC, "%s: unregistered\n", policy->sp_name);
118 EXPORT_SYMBOL(sptlrpc_unregister_policy);
121 struct ptlrpc_sec_policy * sptlrpc_wireflavor2policy(__u32 flavor)
123 static CFS_DECLARE_MUTEX(load_mutex);
124 static cfs_atomic_t loaded = CFS_ATOMIC_INIT(0);
125 struct ptlrpc_sec_policy *policy;
126 __u16 number = SPTLRPC_FLVR_POLICY(flavor);
129 if (number >= SPTLRPC_POLICY_MAX)
133 cfs_read_lock(&policy_lock);
134 policy = policies[number];
135 if (policy && !cfs_try_module_get(policy->sp_owner))
138 flag = cfs_atomic_read(&loaded);
139 cfs_read_unlock(&policy_lock);
141 if (policy != NULL || flag != 0 ||
142 number != SPTLRPC_POLICY_GSS)
145 /* try to load gss module, once */
146 cfs_mutex_down(&load_mutex);
147 if (cfs_atomic_read(&loaded) == 0) {
148 if (cfs_request_module("ptlrpc_gss") == 0)
149 CWARN("module ptlrpc_gss loaded on demand\n");
151 CERROR("Unable to load module ptlrpc_gss\n");
153 cfs_atomic_set(&loaded, 1);
155 cfs_mutex_up(&load_mutex);
161 __u32 sptlrpc_name2flavor_base(const char *name)
163 if (!strcmp(name, "null"))
164 return SPTLRPC_FLVR_NULL;
165 if (!strcmp(name, "plain"))
166 return SPTLRPC_FLVR_PLAIN;
167 if (!strcmp(name, "krb5n"))
168 return SPTLRPC_FLVR_KRB5N;
169 if (!strcmp(name, "krb5a"))
170 return SPTLRPC_FLVR_KRB5A;
171 if (!strcmp(name, "krb5i"))
172 return SPTLRPC_FLVR_KRB5I;
173 if (!strcmp(name, "krb5p"))
174 return SPTLRPC_FLVR_KRB5P;
176 return SPTLRPC_FLVR_INVALID;
178 EXPORT_SYMBOL(sptlrpc_name2flavor_base);
180 const char *sptlrpc_flavor2name_base(__u32 flvr)
182 __u32 base = SPTLRPC_FLVR_BASE(flvr);
184 if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_NULL))
186 else if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_PLAIN))
188 else if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_KRB5N))
190 else if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_KRB5A))
192 else if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_KRB5I))
194 else if (base == SPTLRPC_FLVR_BASE(SPTLRPC_FLVR_KRB5P))
197 CERROR("invalid wire flavor 0x%x\n", flvr);
200 EXPORT_SYMBOL(sptlrpc_flavor2name_base);
202 char *sptlrpc_flavor2name_bulk(struct sptlrpc_flavor *sf,
203 char *buf, int bufsize)
205 if (SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_PLAIN)
206 snprintf(buf, bufsize, "hash:%s",
207 sptlrpc_get_hash_name(sf->u_bulk.hash.hash_alg));
209 snprintf(buf, bufsize, "%s",
210 sptlrpc_flavor2name_base(sf->sf_rpc));
212 buf[bufsize - 1] = '\0';
215 EXPORT_SYMBOL(sptlrpc_flavor2name_bulk);
217 char *sptlrpc_flavor2name(struct sptlrpc_flavor *sf, char *buf, int bufsize)
219 snprintf(buf, bufsize, "%s", sptlrpc_flavor2name_base(sf->sf_rpc));
222 * currently we don't support customized bulk specification for
223 * flavors other than plain
225 if (SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_PLAIN) {
229 sptlrpc_flavor2name_bulk(sf, &bspec[1], sizeof(bspec) - 1);
230 strncat(buf, bspec, bufsize);
233 buf[bufsize - 1] = '\0';
236 EXPORT_SYMBOL(sptlrpc_flavor2name);
238 char *sptlrpc_secflags2str(__u32 flags, char *buf, int bufsize)
242 if (flags & PTLRPC_SEC_FL_REVERSE)
243 strncat(buf, "reverse,", bufsize);
244 if (flags & PTLRPC_SEC_FL_ROOTONLY)
245 strncat(buf, "rootonly,", bufsize);
246 if (flags & PTLRPC_SEC_FL_UDESC)
247 strncat(buf, "udesc,", bufsize);
248 if (flags & PTLRPC_SEC_FL_BULK)
249 strncat(buf, "bulk,", bufsize);
251 strncat(buf, "-,", bufsize);
253 buf[bufsize - 1] = '\0';
256 EXPORT_SYMBOL(sptlrpc_secflags2str);
258 /**************************************************
259 * client context APIs *
260 **************************************************/
263 struct ptlrpc_cli_ctx *get_my_ctx(struct ptlrpc_sec *sec)
265 struct vfs_cred vcred;
266 int create = 1, remove_dead = 1;
269 LASSERT(sec->ps_policy->sp_cops->lookup_ctx);
271 if (sec->ps_flvr.sf_flags & (PTLRPC_SEC_FL_REVERSE |
272 PTLRPC_SEC_FL_ROOTONLY)) {
275 if (sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_REVERSE) {
280 vcred.vc_uid = cfs_curproc_uid();
281 vcred.vc_gid = cfs_curproc_gid();
284 return sec->ps_policy->sp_cops->lookup_ctx(sec, &vcred,
285 create, remove_dead);
288 struct ptlrpc_cli_ctx *sptlrpc_cli_ctx_get(struct ptlrpc_cli_ctx *ctx)
290 LASSERT(cfs_atomic_read(&ctx->cc_refcount) > 0);
291 cfs_atomic_inc(&ctx->cc_refcount);
294 EXPORT_SYMBOL(sptlrpc_cli_ctx_get);
296 void sptlrpc_cli_ctx_put(struct ptlrpc_cli_ctx *ctx, int sync)
298 struct ptlrpc_sec *sec = ctx->cc_sec;
301 LASSERT(cfs_atomic_read(&ctx->cc_refcount));
303 if (!cfs_atomic_dec_and_test(&ctx->cc_refcount))
306 sec->ps_policy->sp_cops->release_ctx(sec, ctx, sync);
308 EXPORT_SYMBOL(sptlrpc_cli_ctx_put);
311 * Expire the client context immediately.
313 * \pre Caller must hold at least 1 reference on the \a ctx.
315 void sptlrpc_cli_ctx_expire(struct ptlrpc_cli_ctx *ctx)
317 LASSERT(ctx->cc_ops->die);
318 ctx->cc_ops->die(ctx, 0);
320 EXPORT_SYMBOL(sptlrpc_cli_ctx_expire);
323 * To wake up the threads who are waiting for this client context. Called
324 * after some status change happened on \a ctx.
326 void sptlrpc_cli_ctx_wakeup(struct ptlrpc_cli_ctx *ctx)
328 struct ptlrpc_request *req, *next;
330 cfs_spin_lock(&ctx->cc_lock);
331 cfs_list_for_each_entry_safe(req, next, &ctx->cc_req_list,
333 cfs_list_del_init(&req->rq_ctx_chain);
334 ptlrpc_client_wake_req(req);
336 cfs_spin_unlock(&ctx->cc_lock);
338 EXPORT_SYMBOL(sptlrpc_cli_ctx_wakeup);
340 int sptlrpc_cli_ctx_display(struct ptlrpc_cli_ctx *ctx, char *buf, int bufsize)
342 LASSERT(ctx->cc_ops);
344 if (ctx->cc_ops->display == NULL)
347 return ctx->cc_ops->display(ctx, buf, bufsize);
350 static int import_sec_check_expire(struct obd_import *imp)
354 cfs_spin_lock(&imp->imp_lock);
355 if (imp->imp_sec_expire &&
356 imp->imp_sec_expire < cfs_time_current_sec()) {
358 imp->imp_sec_expire = 0;
360 cfs_spin_unlock(&imp->imp_lock);
365 CDEBUG(D_SEC, "found delayed sec adapt expired, do it now\n");
366 return sptlrpc_import_sec_adapt(imp, NULL, 0);
369 static int import_sec_validate_get(struct obd_import *imp,
370 struct ptlrpc_sec **sec)
374 if (unlikely(imp->imp_sec_expire)) {
375 rc = import_sec_check_expire(imp);
380 *sec = sptlrpc_import_sec_ref(imp);
382 CERROR("import %p (%s) with no sec\n",
383 imp, ptlrpc_import_state_name(imp->imp_state));
387 if (unlikely((*sec)->ps_dying)) {
388 CERROR("attempt to use dying sec %p\n", sec);
389 sptlrpc_sec_put(*sec);
397 * Given a \a req, find or allocate a appropriate context for it.
398 * \pre req->rq_cli_ctx == NULL.
400 * \retval 0 succeed, and req->rq_cli_ctx is set.
401 * \retval -ev error number, and req->rq_cli_ctx == NULL.
403 int sptlrpc_req_get_ctx(struct ptlrpc_request *req)
405 struct obd_import *imp = req->rq_import;
406 struct ptlrpc_sec *sec;
410 LASSERT(!req->rq_cli_ctx);
413 rc = import_sec_validate_get(imp, &sec);
417 req->rq_cli_ctx = get_my_ctx(sec);
419 sptlrpc_sec_put(sec);
421 if (!req->rq_cli_ctx) {
422 CERROR("req %p: fail to get context\n", req);
430 * Drop the context for \a req.
431 * \pre req->rq_cli_ctx != NULL.
432 * \post req->rq_cli_ctx == NULL.
434 * If \a sync == 0, this function should return quickly without sleep;
435 * otherwise it might trigger and wait for the whole process of sending
436 * an context-destroying rpc to server.
438 void sptlrpc_req_put_ctx(struct ptlrpc_request *req, int sync)
443 LASSERT(req->rq_cli_ctx);
445 /* request might be asked to release earlier while still
446 * in the context waiting list.
448 if (!cfs_list_empty(&req->rq_ctx_chain)) {
449 cfs_spin_lock(&req->rq_cli_ctx->cc_lock);
450 cfs_list_del_init(&req->rq_ctx_chain);
451 cfs_spin_unlock(&req->rq_cli_ctx->cc_lock);
454 sptlrpc_cli_ctx_put(req->rq_cli_ctx, sync);
455 req->rq_cli_ctx = NULL;
460 int sptlrpc_req_ctx_switch(struct ptlrpc_request *req,
461 struct ptlrpc_cli_ctx *oldctx,
462 struct ptlrpc_cli_ctx *newctx)
464 struct sptlrpc_flavor old_flvr;
469 LASSERT(req->rq_reqmsg);
470 LASSERT(req->rq_reqlen);
471 LASSERT(req->rq_replen);
473 CWARN("req %p: switch ctx %p(%u->%s) -> %p(%u->%s), "
474 "switch sec %p(%s) -> %p(%s)\n", req,
475 oldctx, oldctx->cc_vcred.vc_uid, sec2target_str(oldctx->cc_sec),
476 newctx, newctx->cc_vcred.vc_uid, sec2target_str(newctx->cc_sec),
477 oldctx->cc_sec, oldctx->cc_sec->ps_policy->sp_name,
478 newctx->cc_sec, newctx->cc_sec->ps_policy->sp_name);
481 old_flvr = req->rq_flvr;
483 /* save request message */
484 reqmsg_size = req->rq_reqlen;
485 OBD_ALLOC(reqmsg, reqmsg_size);
488 memcpy(reqmsg, req->rq_reqmsg, reqmsg_size);
490 /* release old req/rep buf */
491 req->rq_cli_ctx = oldctx;
492 sptlrpc_cli_free_reqbuf(req);
493 sptlrpc_cli_free_repbuf(req);
494 req->rq_cli_ctx = newctx;
496 /* recalculate the flavor */
497 sptlrpc_req_set_flavor(req, 0);
499 /* alloc new request buffer
500 * we don't need to alloc reply buffer here, leave it to the
501 * rest procedure of ptlrpc
503 rc = sptlrpc_cli_alloc_reqbuf(req, reqmsg_size);
505 LASSERT(req->rq_reqmsg);
506 memcpy(req->rq_reqmsg, reqmsg, reqmsg_size);
508 CWARN("failed to alloc reqbuf: %d\n", rc);
509 req->rq_flvr = old_flvr;
512 OBD_FREE(reqmsg, reqmsg_size);
517 * If current context of \a req is dead somehow, e.g. we just switched flavor
518 * thus marked original contexts dead, we'll find a new context for it. if
519 * no switch is needed, \a req will end up with the same context.
521 * \note a request must have a context, to keep other parts of code happy.
522 * In any case of failure during the switching, we must restore the old one.
524 int sptlrpc_req_replace_dead_ctx(struct ptlrpc_request *req)
526 struct ptlrpc_cli_ctx *oldctx = req->rq_cli_ctx;
527 struct ptlrpc_cli_ctx *newctx;
533 sptlrpc_cli_ctx_get(oldctx);
534 sptlrpc_req_put_ctx(req, 0);
536 rc = sptlrpc_req_get_ctx(req);
538 LASSERT(!req->rq_cli_ctx);
540 /* restore old ctx */
541 req->rq_cli_ctx = oldctx;
545 newctx = req->rq_cli_ctx;
548 if (unlikely(newctx == oldctx &&
549 cfs_test_bit(PTLRPC_CTX_DEAD_BIT, &oldctx->cc_flags))) {
551 * still get the old dead ctx, usually means system too busy
553 CWARN("ctx (%p, fl %lx) doesn't switch, relax a little bit\n",
554 newctx, newctx->cc_flags);
556 cfs_schedule_timeout_and_set_state(CFS_TASK_INTERRUPTIBLE,
560 * it's possible newctx == oldctx if we're switching
561 * subflavor with the same sec.
563 rc = sptlrpc_req_ctx_switch(req, oldctx, newctx);
565 /* restore old ctx */
566 sptlrpc_req_put_ctx(req, 0);
567 req->rq_cli_ctx = oldctx;
571 LASSERT(req->rq_cli_ctx == newctx);
574 sptlrpc_cli_ctx_put(oldctx, 1);
577 EXPORT_SYMBOL(sptlrpc_req_replace_dead_ctx);
580 int ctx_check_refresh(struct ptlrpc_cli_ctx *ctx)
582 if (cli_ctx_is_refreshed(ctx))
588 int ctx_refresh_timeout(void *data)
590 struct ptlrpc_request *req = data;
593 /* conn_cnt is needed in expire_one_request */
594 lustre_msg_set_conn_cnt(req->rq_reqmsg, req->rq_import->imp_conn_cnt);
596 rc = ptlrpc_expire_one_request(req, 1);
597 /* if we started recovery, we should mark this ctx dead; otherwise
598 * in case of lgssd died nobody would retire this ctx, following
599 * connecting will still find the same ctx thus cause deadlock.
600 * there's an assumption that expire time of the request should be
601 * later than the context refresh expire time.
604 req->rq_cli_ctx->cc_ops->die(req->rq_cli_ctx, 0);
609 void ctx_refresh_interrupt(void *data)
611 struct ptlrpc_request *req = data;
613 cfs_spin_lock(&req->rq_lock);
615 cfs_spin_unlock(&req->rq_lock);
619 void req_off_ctx_list(struct ptlrpc_request *req, struct ptlrpc_cli_ctx *ctx)
621 cfs_spin_lock(&ctx->cc_lock);
622 if (!cfs_list_empty(&req->rq_ctx_chain))
623 cfs_list_del_init(&req->rq_ctx_chain);
624 cfs_spin_unlock(&ctx->cc_lock);
628 * To refresh the context of \req, if it's not up-to-date.
631 * - = 0: wait until success or fatal error occur
632 * - > 0: timeout value (in seconds)
634 * The status of the context could be subject to be changed by other threads
635 * at any time. We allow this race, but once we return with 0, the caller will
636 * suppose it's uptodated and keep using it until the owning rpc is done.
638 * \retval 0 only if the context is uptodated.
639 * \retval -ev error number.
641 int sptlrpc_req_refresh_ctx(struct ptlrpc_request *req, long timeout)
643 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
644 struct ptlrpc_sec *sec;
645 struct l_wait_info lwi;
651 if (req->rq_ctx_init || req->rq_ctx_fini)
655 * during the process a request's context might change type even
656 * (e.g. from gss ctx to null ctx), so each loop we need to re-check
660 rc = import_sec_validate_get(req->rq_import, &sec);
664 if (sec->ps_flvr.sf_rpc != req->rq_flvr.sf_rpc) {
665 CDEBUG(D_SEC, "req %p: flavor has changed %x -> %x\n",
666 req, req->rq_flvr.sf_rpc, sec->ps_flvr.sf_rpc);
667 req_off_ctx_list(req, ctx);
668 sptlrpc_req_replace_dead_ctx(req);
669 ctx = req->rq_cli_ctx;
671 sptlrpc_sec_put(sec);
673 if (cli_ctx_is_eternal(ctx))
676 if (unlikely(cfs_test_bit(PTLRPC_CTX_NEW_BIT, &ctx->cc_flags))) {
677 LASSERT(ctx->cc_ops->refresh);
678 ctx->cc_ops->refresh(ctx);
680 LASSERT(cfs_test_bit(PTLRPC_CTX_NEW_BIT, &ctx->cc_flags) == 0);
682 LASSERT(ctx->cc_ops->validate);
683 if (ctx->cc_ops->validate(ctx) == 0) {
684 req_off_ctx_list(req, ctx);
688 if (unlikely(cfs_test_bit(PTLRPC_CTX_ERROR_BIT, &ctx->cc_flags))) {
689 cfs_spin_lock(&req->rq_lock);
691 cfs_spin_unlock(&req->rq_lock);
692 req_off_ctx_list(req, ctx);
697 * There's a subtle issue for resending RPCs, suppose following
699 * 1. the request was sent to server.
700 * 2. recovery was kicked start, after finished the request was
702 * 3. resend the request.
703 * 4. old reply from server received, we accept and verify the reply.
704 * this has to be success, otherwise the error will be aware
706 * 5. new reply from server received, dropped by LNet.
708 * Note the xid of old & new request is the same. We can't simply
709 * change xid for the resent request because the server replies on
710 * it for reply reconstruction.
712 * Commonly the original context should be uptodate because we
713 * have a expiry nice time; server will keep its context because
714 * we at least hold a ref of old context which prevent context
715 * destroying RPC being sent. So server still can accept the request
716 * and finish the RPC. But if that's not the case:
717 * 1. If server side context has been trimmed, a NO_CONTEXT will
718 * be returned, gss_cli_ctx_verify/unseal will switch to new
720 * 2. Current context never be refreshed, then we are fine: we
721 * never really send request with old context before.
723 if (cfs_test_bit(PTLRPC_CTX_UPTODATE_BIT, &ctx->cc_flags) &&
724 unlikely(req->rq_reqmsg) &&
725 lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT) {
726 req_off_ctx_list(req, ctx);
730 if (unlikely(cfs_test_bit(PTLRPC_CTX_DEAD_BIT, &ctx->cc_flags))) {
731 req_off_ctx_list(req, ctx);
733 * don't switch ctx if import was deactivated
735 if (req->rq_import->imp_deactive) {
736 cfs_spin_lock(&req->rq_lock);
738 cfs_spin_unlock(&req->rq_lock);
742 rc = sptlrpc_req_replace_dead_ctx(req);
744 LASSERT(ctx == req->rq_cli_ctx);
745 CERROR("req %p: failed to replace dead ctx %p: %d\n",
747 cfs_spin_lock(&req->rq_lock);
749 cfs_spin_unlock(&req->rq_lock);
753 ctx = req->rq_cli_ctx;
758 * Now we're sure this context is during upcall, add myself into
761 cfs_spin_lock(&ctx->cc_lock);
762 if (cfs_list_empty(&req->rq_ctx_chain))
763 cfs_list_add(&req->rq_ctx_chain, &ctx->cc_req_list);
764 cfs_spin_unlock(&ctx->cc_lock);
767 RETURN(-EWOULDBLOCK);
769 /* Clear any flags that may be present from previous sends */
770 LASSERT(req->rq_receiving_reply == 0);
771 cfs_spin_lock(&req->rq_lock);
773 req->rq_timedout = 0;
776 cfs_spin_unlock(&req->rq_lock);
778 lwi = LWI_TIMEOUT_INTR(timeout * CFS_HZ, ctx_refresh_timeout,
779 ctx_refresh_interrupt, req);
780 rc = l_wait_event(req->rq_reply_waitq, ctx_check_refresh(ctx), &lwi);
783 * following cases could lead us here:
784 * - successfully refreshed;
786 * - timedout, and we don't want recover from the failure;
787 * - timedout, and waked up upon recovery finished;
788 * - someone else mark this ctx dead by force;
789 * - someone invalidate the req and call ptlrpc_client_wake_req(),
790 * e.g. ptlrpc_abort_inflight();
792 if (!cli_ctx_is_refreshed(ctx)) {
793 /* timed out or interruptted */
794 req_off_ctx_list(req, ctx);
804 * Initialize flavor settings for \a req, according to \a opcode.
806 * \note this could be called in two situations:
807 * - new request from ptlrpc_pre_req(), with proper @opcode
808 * - old request which changed ctx in the middle, with @opcode == 0
810 void sptlrpc_req_set_flavor(struct ptlrpc_request *req, int opcode)
812 struct ptlrpc_sec *sec;
814 LASSERT(req->rq_import);
815 LASSERT(req->rq_cli_ctx);
816 LASSERT(req->rq_cli_ctx->cc_sec);
817 LASSERT(req->rq_bulk_read == 0 || req->rq_bulk_write == 0);
819 /* special security flags accoding to opcode */
823 req->rq_bulk_read = 1;
827 req->rq_bulk_write = 1;
830 req->rq_ctx_init = 1;
833 req->rq_ctx_fini = 1;
836 /* init/fini rpc won't be resend, so can't be here */
837 LASSERT(req->rq_ctx_init == 0);
838 LASSERT(req->rq_ctx_fini == 0);
840 /* cleanup flags, which should be recalculated */
841 req->rq_pack_udesc = 0;
842 req->rq_pack_bulk = 0;
846 sec = req->rq_cli_ctx->cc_sec;
848 cfs_spin_lock(&sec->ps_lock);
849 req->rq_flvr = sec->ps_flvr;
850 cfs_spin_unlock(&sec->ps_lock);
852 /* force SVC_NULL for context initiation rpc, SVC_INTG for context
854 if (unlikely(req->rq_ctx_init))
855 flvr_set_svc(&req->rq_flvr.sf_rpc, SPTLRPC_SVC_NULL);
856 else if (unlikely(req->rq_ctx_fini))
857 flvr_set_svc(&req->rq_flvr.sf_rpc, SPTLRPC_SVC_INTG);
859 /* user descriptor flag, null security can't do it anyway */
860 if ((sec->ps_flvr.sf_flags & PTLRPC_SEC_FL_UDESC) &&
861 (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL))
862 req->rq_pack_udesc = 1;
864 /* bulk security flag */
865 if ((req->rq_bulk_read || req->rq_bulk_write) &&
866 sptlrpc_flavor_has_bulk(&req->rq_flvr))
867 req->rq_pack_bulk = 1;
870 void sptlrpc_request_out_callback(struct ptlrpc_request *req)
872 if (SPTLRPC_FLVR_SVC(req->rq_flvr.sf_rpc) != SPTLRPC_SVC_PRIV)
875 LASSERT(req->rq_clrbuf);
876 if (req->rq_pool || !req->rq_reqbuf)
879 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
880 req->rq_reqbuf = NULL;
881 req->rq_reqbuf_len = 0;
885 * Given an import \a imp, check whether current user has a valid context
886 * or not. We may create a new context and try to refresh it, and try
887 * repeatedly try in case of non-fatal errors. Return 0 means success.
889 int sptlrpc_import_check_ctx(struct obd_import *imp)
891 struct ptlrpc_sec *sec;
892 struct ptlrpc_cli_ctx *ctx;
893 struct ptlrpc_request *req = NULL;
899 sec = sptlrpc_import_sec_ref(imp);
900 ctx = get_my_ctx(sec);
901 sptlrpc_sec_put(sec);
906 if (cli_ctx_is_eternal(ctx) ||
907 ctx->cc_ops->validate(ctx) == 0) {
908 sptlrpc_cli_ctx_put(ctx, 1);
912 if (cli_ctx_is_error(ctx)) {
913 sptlrpc_cli_ctx_put(ctx, 1);
921 cfs_spin_lock_init(&req->rq_lock);
922 cfs_atomic_set(&req->rq_refcount, 10000);
923 CFS_INIT_LIST_HEAD(&req->rq_ctx_chain);
924 cfs_waitq_init(&req->rq_reply_waitq);
925 cfs_waitq_init(&req->rq_set_waitq);
926 req->rq_import = imp;
927 req->rq_flvr = sec->ps_flvr;
928 req->rq_cli_ctx = ctx;
930 rc = sptlrpc_req_refresh_ctx(req, 0);
931 LASSERT(cfs_list_empty(&req->rq_ctx_chain));
932 sptlrpc_cli_ctx_put(req->rq_cli_ctx, 1);
939 * Used by ptlrpc client, to perform the pre-defined security transformation
940 * upon the request message of \a req. After this function called,
941 * req->rq_reqmsg is still accessible as clear text.
943 int sptlrpc_cli_wrap_request(struct ptlrpc_request *req)
945 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
950 LASSERT(ctx->cc_sec);
951 LASSERT(req->rq_reqbuf || req->rq_clrbuf);
953 /* we wrap bulk request here because now we can be sure
954 * the context is uptodate.
957 rc = sptlrpc_cli_wrap_bulk(req, req->rq_bulk);
962 switch (SPTLRPC_FLVR_SVC(req->rq_flvr.sf_rpc)) {
963 case SPTLRPC_SVC_NULL:
964 case SPTLRPC_SVC_AUTH:
965 case SPTLRPC_SVC_INTG:
966 LASSERT(ctx->cc_ops->sign);
967 rc = ctx->cc_ops->sign(ctx, req);
969 case SPTLRPC_SVC_PRIV:
970 LASSERT(ctx->cc_ops->seal);
971 rc = ctx->cc_ops->seal(ctx, req);
978 LASSERT(req->rq_reqdata_len);
979 LASSERT(req->rq_reqdata_len % 8 == 0);
980 LASSERT(req->rq_reqdata_len <= req->rq_reqbuf_len);
986 static int do_cli_unwrap_reply(struct ptlrpc_request *req)
988 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
993 LASSERT(ctx->cc_sec);
994 LASSERT(req->rq_repbuf);
995 LASSERT(req->rq_repdata);
996 LASSERT(req->rq_repmsg == NULL);
998 req->rq_rep_swab_mask = 0;
1000 rc = __lustre_unpack_msg(req->rq_repdata, req->rq_repdata_len);
1003 lustre_set_rep_swabbed(req, MSG_PTLRPC_HEADER_OFF);
1007 CERROR("failed unpack reply: x"LPU64"\n", req->rq_xid);
1011 if (req->rq_repdata_len < sizeof(struct lustre_msg)) {
1012 CERROR("replied data length %d too small\n",
1013 req->rq_repdata_len);
1017 if (SPTLRPC_FLVR_POLICY(req->rq_repdata->lm_secflvr) !=
1018 SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc)) {
1019 CERROR("reply policy %u doesn't match request policy %u\n",
1020 SPTLRPC_FLVR_POLICY(req->rq_repdata->lm_secflvr),
1021 SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc));
1025 switch (SPTLRPC_FLVR_SVC(req->rq_flvr.sf_rpc)) {
1026 case SPTLRPC_SVC_NULL:
1027 case SPTLRPC_SVC_AUTH:
1028 case SPTLRPC_SVC_INTG:
1029 LASSERT(ctx->cc_ops->verify);
1030 rc = ctx->cc_ops->verify(ctx, req);
1032 case SPTLRPC_SVC_PRIV:
1033 LASSERT(ctx->cc_ops->unseal);
1034 rc = ctx->cc_ops->unseal(ctx, req);
1039 LASSERT(rc || req->rq_repmsg || req->rq_resend);
1041 if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL &&
1043 req->rq_rep_swab_mask = 0;
1048 * Used by ptlrpc client, to perform security transformation upon the reply
1049 * message of \a req. After return successfully, req->rq_repmsg points to
1050 * the reply message in clear text.
1052 * \pre the reply buffer should have been un-posted from LNet, so nothing is
1055 int sptlrpc_cli_unwrap_reply(struct ptlrpc_request *req)
1057 LASSERT(req->rq_repbuf);
1058 LASSERT(req->rq_repdata == NULL);
1059 LASSERT(req->rq_repmsg == NULL);
1060 LASSERT(req->rq_reply_off + req->rq_nob_received <= req->rq_repbuf_len);
1062 if (req->rq_reply_off == 0 &&
1063 (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)) {
1064 CERROR("real reply with offset 0\n");
1068 if (req->rq_reply_off % 8 != 0) {
1069 CERROR("reply at odd offset %u\n", req->rq_reply_off);
1073 req->rq_repdata = (struct lustre_msg *)
1074 (req->rq_repbuf + req->rq_reply_off);
1075 req->rq_repdata_len = req->rq_nob_received;
1077 return do_cli_unwrap_reply(req);
1081 * Used by ptlrpc client, to perform security transformation upon the early
1082 * reply message of \a req. We expect the rq_reply_off is 0, and
1083 * rq_nob_received is the early reply size.
1085 * Because the receive buffer might be still posted, the reply data might be
1086 * changed at any time, no matter we're holding rq_lock or not. For this reason
1087 * we allocate a separate ptlrpc_request and reply buffer for early reply
1090 * \retval 0 success, \a req_ret is filled with a duplicated ptlrpc_request.
1091 * Later the caller must call sptlrpc_cli_finish_early_reply() on the returned
1092 * \a *req_ret to release it.
1093 * \retval -ev error number, and \a req_ret will not be set.
1095 int sptlrpc_cli_unwrap_early_reply(struct ptlrpc_request *req,
1096 struct ptlrpc_request **req_ret)
1098 struct ptlrpc_request *early_req;
1100 int early_bufsz, early_size;
1104 OBD_ALLOC_PTR(early_req);
1105 if (early_req == NULL)
1108 early_size = req->rq_nob_received;
1109 early_bufsz = size_roundup_power2(early_size);
1110 OBD_ALLOC(early_buf, early_bufsz);
1111 if (early_buf == NULL)
1112 GOTO(err_req, rc = -ENOMEM);
1114 /* sanity checkings and copy data out, do it inside spinlock */
1115 cfs_spin_lock(&req->rq_lock);
1117 if (req->rq_replied) {
1118 cfs_spin_unlock(&req->rq_lock);
1119 GOTO(err_buf, rc = -EALREADY);
1122 LASSERT(req->rq_repbuf);
1123 LASSERT(req->rq_repdata == NULL);
1124 LASSERT(req->rq_repmsg == NULL);
1126 if (req->rq_reply_off != 0) {
1127 CERROR("early reply with offset %u\n", req->rq_reply_off);
1128 cfs_spin_unlock(&req->rq_lock);
1129 GOTO(err_buf, rc = -EPROTO);
1132 if (req->rq_nob_received != early_size) {
1133 /* even another early arrived the size should be the same */
1134 CERROR("data size has changed from %u to %u\n",
1135 early_size, req->rq_nob_received);
1136 cfs_spin_unlock(&req->rq_lock);
1137 GOTO(err_buf, rc = -EINVAL);
1140 if (req->rq_nob_received < sizeof(struct lustre_msg)) {
1141 CERROR("early reply length %d too small\n",
1142 req->rq_nob_received);
1143 cfs_spin_unlock(&req->rq_lock);
1144 GOTO(err_buf, rc = -EALREADY);
1147 memcpy(early_buf, req->rq_repbuf, early_size);
1148 cfs_spin_unlock(&req->rq_lock);
1150 cfs_spin_lock_init(&early_req->rq_lock);
1151 early_req->rq_cli_ctx = sptlrpc_cli_ctx_get(req->rq_cli_ctx);
1152 early_req->rq_flvr = req->rq_flvr;
1153 early_req->rq_repbuf = early_buf;
1154 early_req->rq_repbuf_len = early_bufsz;
1155 early_req->rq_repdata = (struct lustre_msg *) early_buf;
1156 early_req->rq_repdata_len = early_size;
1157 early_req->rq_early = 1;
1158 early_req->rq_reqmsg = req->rq_reqmsg;
1160 rc = do_cli_unwrap_reply(early_req);
1162 DEBUG_REQ(D_ADAPTTO, early_req,
1163 "error %d unwrap early reply", rc);
1167 LASSERT(early_req->rq_repmsg);
1168 *req_ret = early_req;
1172 sptlrpc_cli_ctx_put(early_req->rq_cli_ctx, 1);
1174 OBD_FREE(early_buf, early_bufsz);
1176 OBD_FREE_PTR(early_req);
1181 * Used by ptlrpc client, to release a processed early reply \a early_req.
1183 * \pre \a early_req was obtained from calling sptlrpc_cli_unwrap_early_reply().
1185 void sptlrpc_cli_finish_early_reply(struct ptlrpc_request *early_req)
1187 LASSERT(early_req->rq_repbuf);
1188 LASSERT(early_req->rq_repdata);
1189 LASSERT(early_req->rq_repmsg);
1191 sptlrpc_cli_ctx_put(early_req->rq_cli_ctx, 1);
1192 OBD_FREE(early_req->rq_repbuf, early_req->rq_repbuf_len);
1193 OBD_FREE_PTR(early_req);
1196 /**************************************************
1198 **************************************************/
1201 * "fixed" sec (e.g. null) use sec_id < 0
1203 static cfs_atomic_t sptlrpc_sec_id = CFS_ATOMIC_INIT(1);
1205 int sptlrpc_get_next_secid(void)
1207 return cfs_atomic_inc_return(&sptlrpc_sec_id);
1209 EXPORT_SYMBOL(sptlrpc_get_next_secid);
1211 /**************************************************
1212 * client side high-level security APIs *
1213 **************************************************/
1215 static int sec_cop_flush_ctx_cache(struct ptlrpc_sec *sec, uid_t uid,
1216 int grace, int force)
1218 struct ptlrpc_sec_policy *policy = sec->ps_policy;
1220 LASSERT(policy->sp_cops);
1221 LASSERT(policy->sp_cops->flush_ctx_cache);
1223 return policy->sp_cops->flush_ctx_cache(sec, uid, grace, force);
1226 static void sec_cop_destroy_sec(struct ptlrpc_sec *sec)
1228 struct ptlrpc_sec_policy *policy = sec->ps_policy;
1230 LASSERT(cfs_atomic_read(&sec->ps_refcount) == 0);
1231 LASSERT(cfs_atomic_read(&sec->ps_nctx) == 0);
1232 LASSERT(policy->sp_cops->destroy_sec);
1234 CDEBUG(D_SEC, "%s@%p: being destroied\n", sec->ps_policy->sp_name, sec);
1236 policy->sp_cops->destroy_sec(sec);
1237 sptlrpc_policy_put(policy);
1240 void sptlrpc_sec_destroy(struct ptlrpc_sec *sec)
1242 sec_cop_destroy_sec(sec);
1244 EXPORT_SYMBOL(sptlrpc_sec_destroy);
1246 static void sptlrpc_sec_kill(struct ptlrpc_sec *sec)
1248 LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
1250 if (sec->ps_policy->sp_cops->kill_sec) {
1251 sec->ps_policy->sp_cops->kill_sec(sec);
1253 sec_cop_flush_ctx_cache(sec, -1, 1, 1);
1257 struct ptlrpc_sec *sptlrpc_sec_get(struct ptlrpc_sec *sec)
1260 LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
1261 cfs_atomic_inc(&sec->ps_refcount);
1266 EXPORT_SYMBOL(sptlrpc_sec_get);
1268 void sptlrpc_sec_put(struct ptlrpc_sec *sec)
1271 LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
1273 if (cfs_atomic_dec_and_test(&sec->ps_refcount)) {
1274 LASSERT(cfs_atomic_read(&sec->ps_nctx) == 0);
1276 sptlrpc_gc_del_sec(sec);
1277 sec_cop_destroy_sec(sec);
1281 EXPORT_SYMBOL(sptlrpc_sec_put);
1284 * policy module is responsible for taking refrence of import
1287 struct ptlrpc_sec * sptlrpc_sec_create(struct obd_import *imp,
1288 struct ptlrpc_svc_ctx *svc_ctx,
1289 struct sptlrpc_flavor *sf,
1290 enum lustre_sec_part sp)
1292 struct ptlrpc_sec_policy *policy;
1293 struct ptlrpc_sec *sec;
1298 LASSERT(imp->imp_dlm_fake == 1);
1300 CDEBUG(D_SEC, "%s %s: reverse sec using flavor %s\n",
1301 imp->imp_obd->obd_type->typ_name,
1302 imp->imp_obd->obd_name,
1303 sptlrpc_flavor2name(sf, str, sizeof(str)));
1305 policy = sptlrpc_policy_get(svc_ctx->sc_policy);
1306 sf->sf_flags |= PTLRPC_SEC_FL_REVERSE | PTLRPC_SEC_FL_ROOTONLY;
1308 LASSERT(imp->imp_dlm_fake == 0);
1310 CDEBUG(D_SEC, "%s %s: select security flavor %s\n",
1311 imp->imp_obd->obd_type->typ_name,
1312 imp->imp_obd->obd_name,
1313 sptlrpc_flavor2name(sf, str, sizeof(str)));
1315 policy = sptlrpc_wireflavor2policy(sf->sf_rpc);
1317 CERROR("invalid flavor 0x%x\n", sf->sf_rpc);
1322 sec = policy->sp_cops->create_sec(imp, svc_ctx, sf);
1324 cfs_atomic_inc(&sec->ps_refcount);
1328 if (sec->ps_gc_interval && policy->sp_cops->gc_ctx)
1329 sptlrpc_gc_add_sec(sec);
1331 sptlrpc_policy_put(policy);
1337 struct ptlrpc_sec *sptlrpc_import_sec_ref(struct obd_import *imp)
1339 struct ptlrpc_sec *sec;
1341 cfs_spin_lock(&imp->imp_lock);
1342 sec = sptlrpc_sec_get(imp->imp_sec);
1343 cfs_spin_unlock(&imp->imp_lock);
1347 EXPORT_SYMBOL(sptlrpc_import_sec_ref);
1349 static void sptlrpc_import_sec_install(struct obd_import *imp,
1350 struct ptlrpc_sec *sec)
1352 struct ptlrpc_sec *old_sec;
1354 LASSERT(cfs_atomic_read(&sec->ps_refcount) > 0);
1356 cfs_spin_lock(&imp->imp_lock);
1357 old_sec = imp->imp_sec;
1359 cfs_spin_unlock(&imp->imp_lock);
1362 sptlrpc_sec_kill(old_sec);
1364 /* balance the ref taken by this import */
1365 sptlrpc_sec_put(old_sec);
1370 int flavor_equal(struct sptlrpc_flavor *sf1, struct sptlrpc_flavor *sf2)
1372 return (memcmp(sf1, sf2, sizeof(*sf1)) == 0);
1376 void flavor_copy(struct sptlrpc_flavor *dst, struct sptlrpc_flavor *src)
1381 static void sptlrpc_import_sec_adapt_inplace(struct obd_import *imp,
1382 struct ptlrpc_sec *sec,
1383 struct sptlrpc_flavor *sf)
1385 char str1[32], str2[32];
1387 if (sec->ps_flvr.sf_flags != sf->sf_flags)
1388 CWARN("changing sec flags: %s -> %s\n",
1389 sptlrpc_secflags2str(sec->ps_flvr.sf_flags,
1390 str1, sizeof(str1)),
1391 sptlrpc_secflags2str(sf->sf_flags,
1392 str2, sizeof(str2)));
1394 cfs_spin_lock(&sec->ps_lock);
1395 flavor_copy(&sec->ps_flvr, sf);
1396 cfs_spin_unlock(&sec->ps_lock);
1400 * To get an appropriate ptlrpc_sec for the \a imp, according to the current
1401 * configuration. Upon called, imp->imp_sec may or may not be NULL.
1403 * - regular import: \a svc_ctx should be NULL and \a flvr is ignored;
1404 * - reverse import: \a svc_ctx and \a flvr are obtained from incoming request.
1406 int sptlrpc_import_sec_adapt(struct obd_import *imp,
1407 struct ptlrpc_svc_ctx *svc_ctx,
1408 struct sptlrpc_flavor *flvr)
1410 struct ptlrpc_connection *conn;
1411 struct sptlrpc_flavor sf;
1412 struct ptlrpc_sec *sec, *newsec;
1413 enum lustre_sec_part sp;
1423 conn = imp->imp_connection;
1425 if (svc_ctx == NULL) {
1426 struct client_obd *cliobd = &imp->imp_obd->u.cli;
1428 * normal import, determine flavor from rule set, except
1429 * for mgc the flavor is predetermined.
1431 if (cliobd->cl_sp_me == LUSTRE_SP_MGC)
1432 sf = cliobd->cl_flvr_mgc;
1434 sptlrpc_conf_choose_flavor(cliobd->cl_sp_me,
1436 &cliobd->cl_target_uuid,
1439 sp = imp->imp_obd->u.cli.cl_sp_me;
1441 /* reverse import, determine flavor from incoming reqeust */
1444 if (sf.sf_rpc != SPTLRPC_FLVR_NULL)
1445 sf.sf_flags = PTLRPC_SEC_FL_REVERSE |
1446 PTLRPC_SEC_FL_ROOTONLY;
1448 sp = sptlrpc_target_sec_part(imp->imp_obd);
1451 sec = sptlrpc_import_sec_ref(imp);
1455 if (flavor_equal(&sf, &sec->ps_flvr))
1458 CWARN("import %s->%s: changing flavor %s -> %s\n",
1459 imp->imp_obd->obd_name,
1460 obd_uuid2str(&conn->c_remote_uuid),
1461 sptlrpc_flavor2name(&sec->ps_flvr, str, sizeof(str)),
1462 sptlrpc_flavor2name(&sf, str2, sizeof(str2)));
1464 if (SPTLRPC_FLVR_POLICY(sf.sf_rpc) ==
1465 SPTLRPC_FLVR_POLICY(sec->ps_flvr.sf_rpc) &&
1466 SPTLRPC_FLVR_MECH(sf.sf_rpc) ==
1467 SPTLRPC_FLVR_MECH(sec->ps_flvr.sf_rpc)) {
1468 sptlrpc_import_sec_adapt_inplace(imp, sec, &sf);
1472 CWARN("import %s->%s netid %x: select flavor %s\n",
1473 imp->imp_obd->obd_name,
1474 obd_uuid2str(&conn->c_remote_uuid),
1475 LNET_NIDNET(conn->c_self),
1476 sptlrpc_flavor2name(&sf, str, sizeof(str)));
1479 cfs_mutex_down(&imp->imp_sec_mutex);
1481 newsec = sptlrpc_sec_create(imp, svc_ctx, &sf, sp);
1483 sptlrpc_import_sec_install(imp, newsec);
1485 CERROR("import %s->%s: failed to create new sec\n",
1486 imp->imp_obd->obd_name,
1487 obd_uuid2str(&conn->c_remote_uuid));
1491 cfs_mutex_up(&imp->imp_sec_mutex);
1493 sptlrpc_sec_put(sec);
1497 void sptlrpc_import_sec_put(struct obd_import *imp)
1500 sptlrpc_sec_kill(imp->imp_sec);
1502 sptlrpc_sec_put(imp->imp_sec);
1503 imp->imp_sec = NULL;
1507 static void import_flush_ctx_common(struct obd_import *imp,
1508 uid_t uid, int grace, int force)
1510 struct ptlrpc_sec *sec;
1515 sec = sptlrpc_import_sec_ref(imp);
1519 sec_cop_flush_ctx_cache(sec, uid, grace, force);
1520 sptlrpc_sec_put(sec);
1523 void sptlrpc_import_flush_root_ctx(struct obd_import *imp)
1525 /* it's important to use grace mode, see explain in
1526 * sptlrpc_req_refresh_ctx() */
1527 import_flush_ctx_common(imp, 0, 1, 1);
1530 void sptlrpc_import_flush_my_ctx(struct obd_import *imp)
1532 import_flush_ctx_common(imp, cfs_curproc_uid(), 1, 1);
1534 EXPORT_SYMBOL(sptlrpc_import_flush_my_ctx);
1536 void sptlrpc_import_flush_all_ctx(struct obd_import *imp)
1538 import_flush_ctx_common(imp, -1, 1, 1);
1540 EXPORT_SYMBOL(sptlrpc_import_flush_all_ctx);
1543 * Used by ptlrpc client to allocate request buffer of \a req. Upon return
1544 * successfully, req->rq_reqmsg points to a buffer with size \a msgsize.
1546 int sptlrpc_cli_alloc_reqbuf(struct ptlrpc_request *req, int msgsize)
1548 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
1549 struct ptlrpc_sec_policy *policy;
1553 LASSERT(cfs_atomic_read(&ctx->cc_refcount));
1554 LASSERT(ctx->cc_sec);
1555 LASSERT(ctx->cc_sec->ps_policy);
1556 LASSERT(req->rq_reqmsg == NULL);
1558 policy = ctx->cc_sec->ps_policy;
1559 rc = policy->sp_cops->alloc_reqbuf(ctx->cc_sec, req, msgsize);
1561 LASSERT(req->rq_reqmsg);
1562 LASSERT(req->rq_reqbuf || req->rq_clrbuf);
1564 /* zeroing preallocated buffer */
1566 memset(req->rq_reqmsg, 0, msgsize);
1573 * Used by ptlrpc client to free request buffer of \a req. After this
1574 * req->rq_reqmsg is set to NULL and should not be accessed anymore.
1576 void sptlrpc_cli_free_reqbuf(struct ptlrpc_request *req)
1578 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
1579 struct ptlrpc_sec_policy *policy;
1582 LASSERT(cfs_atomic_read(&ctx->cc_refcount));
1583 LASSERT(ctx->cc_sec);
1584 LASSERT(ctx->cc_sec->ps_policy);
1586 if (req->rq_reqbuf == NULL && req->rq_clrbuf == NULL)
1589 policy = ctx->cc_sec->ps_policy;
1590 policy->sp_cops->free_reqbuf(ctx->cc_sec, req);
1591 req->rq_reqmsg = NULL;
1595 * NOTE caller must guarantee the buffer size is enough for the enlargement
1597 void _sptlrpc_enlarge_msg_inplace(struct lustre_msg *msg,
1598 int segment, int newsize)
1601 int oldsize, oldmsg_size, movesize;
1603 LASSERT(segment < msg->lm_bufcount);
1604 LASSERT(msg->lm_buflens[segment] <= newsize);
1606 if (msg->lm_buflens[segment] == newsize)
1609 /* nothing to do if we are enlarging the last segment */
1610 if (segment == msg->lm_bufcount - 1) {
1611 msg->lm_buflens[segment] = newsize;
1615 oldsize = msg->lm_buflens[segment];
1617 src = lustre_msg_buf(msg, segment + 1, 0);
1618 msg->lm_buflens[segment] = newsize;
1619 dst = lustre_msg_buf(msg, segment + 1, 0);
1620 msg->lm_buflens[segment] = oldsize;
1622 /* move from segment + 1 to end segment */
1623 LASSERT(msg->lm_magic == LUSTRE_MSG_MAGIC_V2);
1624 oldmsg_size = lustre_msg_size_v2(msg->lm_bufcount, msg->lm_buflens);
1625 movesize = oldmsg_size - ((unsigned long) src - (unsigned long) msg);
1626 LASSERT(movesize >= 0);
1629 memmove(dst, src, movesize);
1631 /* note we don't clear the ares where old data live, not secret */
1633 /* finally set new segment size */
1634 msg->lm_buflens[segment] = newsize;
1636 EXPORT_SYMBOL(_sptlrpc_enlarge_msg_inplace);
1639 * Used by ptlrpc client to enlarge the \a segment of request message pointed
1640 * by req->rq_reqmsg to size \a newsize, all previously filled-in data will be
1641 * preserved after the enlargement. this must be called after original request
1642 * buffer being allocated.
1644 * \note after this be called, rq_reqmsg and rq_reqlen might have been changed,
1645 * so caller should refresh its local pointers if needed.
1647 int sptlrpc_cli_enlarge_reqbuf(struct ptlrpc_request *req,
1648 int segment, int newsize)
1650 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
1651 struct ptlrpc_sec_cops *cops;
1652 struct lustre_msg *msg = req->rq_reqmsg;
1656 LASSERT(msg->lm_bufcount > segment);
1657 LASSERT(msg->lm_buflens[segment] <= newsize);
1659 if (msg->lm_buflens[segment] == newsize)
1662 cops = ctx->cc_sec->ps_policy->sp_cops;
1663 LASSERT(cops->enlarge_reqbuf);
1664 return cops->enlarge_reqbuf(ctx->cc_sec, req, segment, newsize);
1666 EXPORT_SYMBOL(sptlrpc_cli_enlarge_reqbuf);
1669 * Used by ptlrpc client to allocate reply buffer of \a req.
1671 * \note After this, req->rq_repmsg is still not accessible.
1673 int sptlrpc_cli_alloc_repbuf(struct ptlrpc_request *req, int msgsize)
1675 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
1676 struct ptlrpc_sec_policy *policy;
1680 LASSERT(cfs_atomic_read(&ctx->cc_refcount));
1681 LASSERT(ctx->cc_sec);
1682 LASSERT(ctx->cc_sec->ps_policy);
1687 policy = ctx->cc_sec->ps_policy;
1688 RETURN(policy->sp_cops->alloc_repbuf(ctx->cc_sec, req, msgsize));
1692 * Used by ptlrpc client to free reply buffer of \a req. After this
1693 * req->rq_repmsg is set to NULL and should not be accessed anymore.
1695 void sptlrpc_cli_free_repbuf(struct ptlrpc_request *req)
1697 struct ptlrpc_cli_ctx *ctx = req->rq_cli_ctx;
1698 struct ptlrpc_sec_policy *policy;
1702 LASSERT(cfs_atomic_read(&ctx->cc_refcount));
1703 LASSERT(ctx->cc_sec);
1704 LASSERT(ctx->cc_sec->ps_policy);
1706 if (req->rq_repbuf == NULL)
1708 LASSERT(req->rq_repbuf_len);
1710 policy = ctx->cc_sec->ps_policy;
1711 policy->sp_cops->free_repbuf(ctx->cc_sec, req);
1712 req->rq_repmsg = NULL;
1716 int sptlrpc_cli_install_rvs_ctx(struct obd_import *imp,
1717 struct ptlrpc_cli_ctx *ctx)
1719 struct ptlrpc_sec_policy *policy = ctx->cc_sec->ps_policy;
1721 if (!policy->sp_cops->install_rctx)
1723 return policy->sp_cops->install_rctx(imp, ctx->cc_sec, ctx);
1726 int sptlrpc_svc_install_rvs_ctx(struct obd_import *imp,
1727 struct ptlrpc_svc_ctx *ctx)
1729 struct ptlrpc_sec_policy *policy = ctx->sc_policy;
1731 if (!policy->sp_sops->install_rctx)
1733 return policy->sp_sops->install_rctx(imp, ctx);
1736 /****************************************
1737 * server side security *
1738 ****************************************/
1740 static int flavor_allowed(struct sptlrpc_flavor *exp,
1741 struct ptlrpc_request *req)
1743 struct sptlrpc_flavor *flvr = &req->rq_flvr;
1745 if (exp->sf_rpc == SPTLRPC_FLVR_ANY || exp->sf_rpc == flvr->sf_rpc)
1748 if ((req->rq_ctx_init || req->rq_ctx_fini) &&
1749 SPTLRPC_FLVR_POLICY(exp->sf_rpc) ==
1750 SPTLRPC_FLVR_POLICY(flvr->sf_rpc) &&
1751 SPTLRPC_FLVR_MECH(exp->sf_rpc) == SPTLRPC_FLVR_MECH(flvr->sf_rpc))
1757 #define EXP_FLVR_UPDATE_EXPIRE (OBD_TIMEOUT_DEFAULT + 10)
1760 * Given an export \a exp, check whether the flavor of incoming \a req
1761 * is allowed by the export \a exp. Main logic is about taking care of
1762 * changing configurations. Return 0 means success.
1764 int sptlrpc_target_export_check(struct obd_export *exp,
1765 struct ptlrpc_request *req)
1767 struct sptlrpc_flavor flavor;
1772 /* client side export has no imp_reverse, skip
1773 * FIXME maybe we should check flavor this as well??? */
1774 if (exp->exp_imp_reverse == NULL)
1777 /* don't care about ctx fini rpc */
1778 if (req->rq_ctx_fini)
1781 cfs_spin_lock(&exp->exp_lock);
1783 /* if flavor just changed (exp->exp_flvr_changed != 0), we wait for
1784 * the first req with the new flavor, then treat it as current flavor,
1785 * adapt reverse sec according to it.
1786 * note the first rpc with new flavor might not be with root ctx, in
1787 * which case delay the sec_adapt by leaving exp_flvr_adapt == 1. */
1788 if (unlikely(exp->exp_flvr_changed) &&
1789 flavor_allowed(&exp->exp_flvr_old[1], req)) {
1790 /* make the new flavor as "current", and old ones as
1791 * about-to-expire */
1792 CDEBUG(D_SEC, "exp %p: just changed: %x->%x\n", exp,
1793 exp->exp_flvr.sf_rpc, exp->exp_flvr_old[1].sf_rpc);
1794 flavor = exp->exp_flvr_old[1];
1795 exp->exp_flvr_old[1] = exp->exp_flvr_old[0];
1796 exp->exp_flvr_expire[1] = exp->exp_flvr_expire[0];
1797 exp->exp_flvr_old[0] = exp->exp_flvr;
1798 exp->exp_flvr_expire[0] = cfs_time_current_sec() +
1799 EXP_FLVR_UPDATE_EXPIRE;
1800 exp->exp_flvr = flavor;
1802 /* flavor change finished */
1803 exp->exp_flvr_changed = 0;
1804 LASSERT(exp->exp_flvr_adapt == 1);
1806 /* if it's gss, we only interested in root ctx init */
1807 if (req->rq_auth_gss &&
1808 !(req->rq_ctx_init && (req->rq_auth_usr_root ||
1809 req->rq_auth_usr_mdt))) {
1810 cfs_spin_unlock(&exp->exp_lock);
1811 CDEBUG(D_SEC, "is good but not root(%d:%d:%d:%d)\n",
1812 req->rq_auth_gss, req->rq_ctx_init,
1813 req->rq_auth_usr_root, req->rq_auth_usr_mdt);
1817 exp->exp_flvr_adapt = 0;
1818 cfs_spin_unlock(&exp->exp_lock);
1820 return sptlrpc_import_sec_adapt(exp->exp_imp_reverse,
1821 req->rq_svc_ctx, &flavor);
1824 /* if it equals to the current flavor, we accept it, but need to
1825 * dealing with reverse sec/ctx */
1826 if (likely(flavor_allowed(&exp->exp_flvr, req))) {
1827 /* most cases should return here, we only interested in
1828 * gss root ctx init */
1829 if (!req->rq_auth_gss || !req->rq_ctx_init ||
1830 (!req->rq_auth_usr_root && !req->rq_auth_usr_mdt)) {
1831 cfs_spin_unlock(&exp->exp_lock);
1835 /* if flavor just changed, we should not proceed, just leave
1836 * it and current flavor will be discovered and replaced
1837 * shortly, and let _this_ rpc pass through */
1838 if (exp->exp_flvr_changed) {
1839 LASSERT(exp->exp_flvr_adapt);
1840 cfs_spin_unlock(&exp->exp_lock);
1844 if (exp->exp_flvr_adapt) {
1845 exp->exp_flvr_adapt = 0;
1846 CDEBUG(D_SEC, "exp %p (%x|%x|%x): do delayed adapt\n",
1847 exp, exp->exp_flvr.sf_rpc,
1848 exp->exp_flvr_old[0].sf_rpc,
1849 exp->exp_flvr_old[1].sf_rpc);
1850 flavor = exp->exp_flvr;
1851 cfs_spin_unlock(&exp->exp_lock);
1853 return sptlrpc_import_sec_adapt(exp->exp_imp_reverse,
1857 CDEBUG(D_SEC, "exp %p (%x|%x|%x): is current flavor, "
1858 "install rvs ctx\n", exp, exp->exp_flvr.sf_rpc,
1859 exp->exp_flvr_old[0].sf_rpc,
1860 exp->exp_flvr_old[1].sf_rpc);
1861 cfs_spin_unlock(&exp->exp_lock);
1863 return sptlrpc_svc_install_rvs_ctx(exp->exp_imp_reverse,
1868 if (exp->exp_flvr_expire[0]) {
1869 if (exp->exp_flvr_expire[0] >= cfs_time_current_sec()) {
1870 if (flavor_allowed(&exp->exp_flvr_old[0], req)) {
1871 CDEBUG(D_SEC, "exp %p (%x|%x|%x): match the "
1872 "middle one ("CFS_DURATION_T")\n", exp,
1873 exp->exp_flvr.sf_rpc,
1874 exp->exp_flvr_old[0].sf_rpc,
1875 exp->exp_flvr_old[1].sf_rpc,
1876 exp->exp_flvr_expire[0] -
1877 cfs_time_current_sec());
1878 cfs_spin_unlock(&exp->exp_lock);
1882 CDEBUG(D_SEC, "mark middle expired\n");
1883 exp->exp_flvr_expire[0] = 0;
1885 CDEBUG(D_SEC, "exp %p (%x|%x|%x): %x not match middle\n", exp,
1886 exp->exp_flvr.sf_rpc,
1887 exp->exp_flvr_old[0].sf_rpc, exp->exp_flvr_old[1].sf_rpc,
1888 req->rq_flvr.sf_rpc);
1891 /* now it doesn't match the current flavor, the only chance we can
1892 * accept it is match the old flavors which is not expired. */
1893 if (exp->exp_flvr_changed == 0 && exp->exp_flvr_expire[1]) {
1894 if (exp->exp_flvr_expire[1] >= cfs_time_current_sec()) {
1895 if (flavor_allowed(&exp->exp_flvr_old[1], req)) {
1896 CDEBUG(D_SEC, "exp %p (%x|%x|%x): match the "
1897 "oldest one ("CFS_DURATION_T")\n", exp,
1898 exp->exp_flvr.sf_rpc,
1899 exp->exp_flvr_old[0].sf_rpc,
1900 exp->exp_flvr_old[1].sf_rpc,
1901 exp->exp_flvr_expire[1] -
1902 cfs_time_current_sec());
1903 cfs_spin_unlock(&exp->exp_lock);
1907 CDEBUG(D_SEC, "mark oldest expired\n");
1908 exp->exp_flvr_expire[1] = 0;
1910 CDEBUG(D_SEC, "exp %p (%x|%x|%x): %x not match found\n",
1911 exp, exp->exp_flvr.sf_rpc,
1912 exp->exp_flvr_old[0].sf_rpc, exp->exp_flvr_old[1].sf_rpc,
1913 req->rq_flvr.sf_rpc);
1915 CDEBUG(D_SEC, "exp %p (%x|%x|%x): skip the last one\n",
1916 exp, exp->exp_flvr.sf_rpc, exp->exp_flvr_old[0].sf_rpc,
1917 exp->exp_flvr_old[1].sf_rpc);
1920 cfs_spin_unlock(&exp->exp_lock);
1922 CWARN("exp %p(%s): req %p (%u|%u|%u|%u|%u) with "
1923 "unauthorized flavor %x, expect %x|%x(%+ld)|%x(%+ld)\n",
1924 exp, exp->exp_obd->obd_name,
1925 req, req->rq_auth_gss, req->rq_ctx_init, req->rq_ctx_fini,
1926 req->rq_auth_usr_root, req->rq_auth_usr_mdt, req->rq_flvr.sf_rpc,
1927 exp->exp_flvr.sf_rpc,
1928 exp->exp_flvr_old[0].sf_rpc,
1929 exp->exp_flvr_expire[0] ?
1930 (unsigned long) (exp->exp_flvr_expire[0] -
1931 cfs_time_current_sec()) : 0,
1932 exp->exp_flvr_old[1].sf_rpc,
1933 exp->exp_flvr_expire[1] ?
1934 (unsigned long) (exp->exp_flvr_expire[1] -
1935 cfs_time_current_sec()) : 0);
1938 EXPORT_SYMBOL(sptlrpc_target_export_check);
1940 void sptlrpc_target_update_exp_flavor(struct obd_device *obd,
1941 struct sptlrpc_rule_set *rset)
1943 struct obd_export *exp;
1944 struct sptlrpc_flavor new_flvr;
1948 cfs_spin_lock(&obd->obd_dev_lock);
1950 cfs_list_for_each_entry(exp, &obd->obd_exports, exp_obd_chain) {
1951 if (exp->exp_connection == NULL)
1954 /* note if this export had just been updated flavor
1955 * (exp_flvr_changed == 1), this will override the
1957 cfs_spin_lock(&exp->exp_lock);
1958 sptlrpc_target_choose_flavor(rset, exp->exp_sp_peer,
1959 exp->exp_connection->c_peer.nid,
1961 if (exp->exp_flvr_changed ||
1962 !flavor_equal(&new_flvr, &exp->exp_flvr)) {
1963 exp->exp_flvr_old[1] = new_flvr;
1964 exp->exp_flvr_expire[1] = 0;
1965 exp->exp_flvr_changed = 1;
1966 exp->exp_flvr_adapt = 1;
1968 CDEBUG(D_SEC, "exp %p (%s): updated flavor %x->%x\n",
1969 exp, sptlrpc_part2name(exp->exp_sp_peer),
1970 exp->exp_flvr.sf_rpc,
1971 exp->exp_flvr_old[1].sf_rpc);
1973 cfs_spin_unlock(&exp->exp_lock);
1976 cfs_spin_unlock(&obd->obd_dev_lock);
1978 EXPORT_SYMBOL(sptlrpc_target_update_exp_flavor);
1980 static int sptlrpc_svc_check_from(struct ptlrpc_request *req, int svc_rc)
1982 if (svc_rc == SECSVC_DROP)
1985 switch (req->rq_sp_from) {
1994 DEBUG_REQ(D_ERROR, req, "invalid source %u", req->rq_sp_from);
1998 if (!req->rq_auth_gss)
2001 if (unlikely(req->rq_sp_from == LUSTRE_SP_ANY)) {
2002 CERROR("not specific part\n");
2006 /* from MDT, must be authenticated as MDT */
2007 if (unlikely(req->rq_sp_from == LUSTRE_SP_MDT &&
2008 !req->rq_auth_usr_mdt)) {
2009 DEBUG_REQ(D_ERROR, req, "fake source MDT");
2013 /* from OST, must be callback to MDT and CLI, the reverse sec
2014 * was from mdt/root keytab, so it should be MDT or root FIXME */
2015 if (unlikely(req->rq_sp_from == LUSTRE_SP_OST &&
2016 !req->rq_auth_usr_mdt && !req->rq_auth_usr_root)) {
2017 DEBUG_REQ(D_ERROR, req, "fake source OST");
2025 * Used by ptlrpc server, to perform transformation upon request message of
2026 * incoming \a req. This must be the first thing to do with a incoming
2027 * request in ptlrpc layer.
2029 * \retval SECSVC_OK success, and req->rq_reqmsg point to request message in
2030 * clear text, size is req->rq_reqlen; also req->rq_svc_ctx is set.
2031 * \retval SECSVC_COMPLETE success, the request has been fully processed, and
2032 * reply message has been prepared.
2033 * \retval SECSVC_DROP failed, this request should be dropped.
2035 int sptlrpc_svc_unwrap_request(struct ptlrpc_request *req)
2037 struct ptlrpc_sec_policy *policy;
2038 struct lustre_msg *msg = req->rq_reqbuf;
2043 LASSERT(req->rq_reqmsg == NULL);
2044 LASSERT(req->rq_repmsg == NULL);
2045 LASSERT(req->rq_svc_ctx == NULL);
2047 req->rq_req_swab_mask = 0;
2049 rc = __lustre_unpack_msg(msg, req->rq_reqdata_len);
2052 lustre_set_req_swabbed(req, MSG_PTLRPC_HEADER_OFF);
2056 CERROR("error unpacking request from %s x"LPU64"\n",
2057 libcfs_id2str(req->rq_peer), req->rq_xid);
2058 RETURN(SECSVC_DROP);
2061 req->rq_flvr.sf_rpc = WIRE_FLVR(msg->lm_secflvr);
2062 req->rq_sp_from = LUSTRE_SP_ANY;
2063 req->rq_auth_uid = INVALID_UID;
2064 req->rq_auth_mapped_uid = INVALID_UID;
2066 policy = sptlrpc_wireflavor2policy(req->rq_flvr.sf_rpc);
2068 CERROR("unsupported rpc flavor %x\n", req->rq_flvr.sf_rpc);
2069 RETURN(SECSVC_DROP);
2072 LASSERT(policy->sp_sops->accept);
2073 rc = policy->sp_sops->accept(req);
2074 sptlrpc_policy_put(policy);
2075 LASSERT(req->rq_reqmsg || rc != SECSVC_OK);
2076 LASSERT(req->rq_svc_ctx || rc == SECSVC_DROP);
2079 * if it's not null flavor (which means embedded packing msg),
2080 * reset the swab mask for the comming inner msg unpacking.
2082 if (SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) != SPTLRPC_POLICY_NULL)
2083 req->rq_req_swab_mask = 0;
2085 /* sanity check for the request source */
2086 rc = sptlrpc_svc_check_from(req, rc);
2091 * Used by ptlrpc server, to allocate reply buffer for \a req. If succeed,
2092 * req->rq_reply_state is set, and req->rq_reply_state->rs_msg point to
2093 * a buffer of \a msglen size.
2095 int sptlrpc_svc_alloc_rs(struct ptlrpc_request *req, int msglen)
2097 struct ptlrpc_sec_policy *policy;
2098 struct ptlrpc_reply_state *rs;
2102 LASSERT(req->rq_svc_ctx);
2103 LASSERT(req->rq_svc_ctx->sc_policy);
2105 policy = req->rq_svc_ctx->sc_policy;
2106 LASSERT(policy->sp_sops->alloc_rs);
2108 rc = policy->sp_sops->alloc_rs(req, msglen);
2109 if (unlikely(rc == -ENOMEM)) {
2110 /* failed alloc, try emergency pool */
2111 rs = lustre_get_emerg_rs(req->rq_rqbd->rqbd_service);
2115 req->rq_reply_state = rs;
2116 rc = policy->sp_sops->alloc_rs(req, msglen);
2118 lustre_put_emerg_rs(rs);
2119 req->rq_reply_state = NULL;
2124 (req->rq_reply_state && req->rq_reply_state->rs_msg));
2130 * Used by ptlrpc server, to perform transformation upon reply message.
2132 * \post req->rq_reply_off is set to approriate server-controlled reply offset.
2133 * \post req->rq_repmsg and req->rq_reply_state->rs_msg becomes inaccessible.
2135 int sptlrpc_svc_wrap_reply(struct ptlrpc_request *req)
2137 struct ptlrpc_sec_policy *policy;
2141 LASSERT(req->rq_svc_ctx);
2142 LASSERT(req->rq_svc_ctx->sc_policy);
2144 policy = req->rq_svc_ctx->sc_policy;
2145 LASSERT(policy->sp_sops->authorize);
2147 rc = policy->sp_sops->authorize(req);
2148 LASSERT(rc || req->rq_reply_state->rs_repdata_len);
2154 * Used by ptlrpc server, to free reply_state.
2156 void sptlrpc_svc_free_rs(struct ptlrpc_reply_state *rs)
2158 struct ptlrpc_sec_policy *policy;
2159 unsigned int prealloc;
2162 LASSERT(rs->rs_svc_ctx);
2163 LASSERT(rs->rs_svc_ctx->sc_policy);
2165 policy = rs->rs_svc_ctx->sc_policy;
2166 LASSERT(policy->sp_sops->free_rs);
2168 prealloc = rs->rs_prealloc;
2169 policy->sp_sops->free_rs(rs);
2172 lustre_put_emerg_rs(rs);
2176 void sptlrpc_svc_ctx_addref(struct ptlrpc_request *req)
2178 struct ptlrpc_svc_ctx *ctx = req->rq_svc_ctx;
2183 LASSERT(cfs_atomic_read(&ctx->sc_refcount) > 0);
2184 cfs_atomic_inc(&ctx->sc_refcount);
2187 void sptlrpc_svc_ctx_decref(struct ptlrpc_request *req)
2189 struct ptlrpc_svc_ctx *ctx = req->rq_svc_ctx;
2194 LASSERT(cfs_atomic_read(&ctx->sc_refcount) > 0);
2195 if (cfs_atomic_dec_and_test(&ctx->sc_refcount)) {
2196 if (ctx->sc_policy->sp_sops->free_ctx)
2197 ctx->sc_policy->sp_sops->free_ctx(ctx);
2199 req->rq_svc_ctx = NULL;
2202 void sptlrpc_svc_ctx_invalidate(struct ptlrpc_request *req)
2204 struct ptlrpc_svc_ctx *ctx = req->rq_svc_ctx;
2209 LASSERT(cfs_atomic_read(&ctx->sc_refcount) > 0);
2210 if (ctx->sc_policy->sp_sops->invalidate_ctx)
2211 ctx->sc_policy->sp_sops->invalidate_ctx(ctx);
2213 EXPORT_SYMBOL(sptlrpc_svc_ctx_invalidate);
2215 /****************************************
2217 ****************************************/
2220 * Perform transformation upon bulk data pointed by \a desc. This is called
2221 * before transforming the request message.
2223 int sptlrpc_cli_wrap_bulk(struct ptlrpc_request *req,
2224 struct ptlrpc_bulk_desc *desc)
2226 struct ptlrpc_cli_ctx *ctx;
2228 LASSERT(req->rq_bulk_read || req->rq_bulk_write);
2230 if (!req->rq_pack_bulk)
2233 ctx = req->rq_cli_ctx;
2234 if (ctx->cc_ops->wrap_bulk)
2235 return ctx->cc_ops->wrap_bulk(ctx, req, desc);
2238 EXPORT_SYMBOL(sptlrpc_cli_wrap_bulk);
2241 * This is called after unwrap the reply message.
2242 * return nob of actual plain text size received, or error code.
2244 int sptlrpc_cli_unwrap_bulk_read(struct ptlrpc_request *req,
2245 struct ptlrpc_bulk_desc *desc,
2248 struct ptlrpc_cli_ctx *ctx;
2251 LASSERT(req->rq_bulk_read && !req->rq_bulk_write);
2253 if (!req->rq_pack_bulk)
2254 return desc->bd_nob_transferred;
2256 ctx = req->rq_cli_ctx;
2257 if (ctx->cc_ops->unwrap_bulk) {
2258 rc = ctx->cc_ops->unwrap_bulk(ctx, req, desc);
2262 return desc->bd_nob_transferred;
2264 EXPORT_SYMBOL(sptlrpc_cli_unwrap_bulk_read);
2267 * This is called after unwrap the reply message.
2268 * return 0 for success or error code.
2270 int sptlrpc_cli_unwrap_bulk_write(struct ptlrpc_request *req,
2271 struct ptlrpc_bulk_desc *desc)
2273 struct ptlrpc_cli_ctx *ctx;
2276 LASSERT(!req->rq_bulk_read && req->rq_bulk_write);
2278 if (!req->rq_pack_bulk)
2281 ctx = req->rq_cli_ctx;
2282 if (ctx->cc_ops->unwrap_bulk) {
2283 rc = ctx->cc_ops->unwrap_bulk(ctx, req, desc);
2289 * if everything is going right, nob should equals to nob_transferred.
2290 * in case of privacy mode, nob_transferred needs to be adjusted.
2292 if (desc->bd_nob != desc->bd_nob_transferred) {
2293 CERROR("nob %d doesn't match transferred nob %d",
2294 desc->bd_nob, desc->bd_nob_transferred);
2300 EXPORT_SYMBOL(sptlrpc_cli_unwrap_bulk_write);
2303 * Performe transformation upon outgoing bulk read.
2305 int sptlrpc_svc_wrap_bulk(struct ptlrpc_request *req,
2306 struct ptlrpc_bulk_desc *desc)
2308 struct ptlrpc_svc_ctx *ctx;
2310 LASSERT(req->rq_bulk_read);
2312 if (!req->rq_pack_bulk)
2315 ctx = req->rq_svc_ctx;
2316 if (ctx->sc_policy->sp_sops->wrap_bulk)
2317 return ctx->sc_policy->sp_sops->wrap_bulk(req, desc);
2321 EXPORT_SYMBOL(sptlrpc_svc_wrap_bulk);
2324 * Performe transformation upon incoming bulk write.
2326 int sptlrpc_svc_unwrap_bulk(struct ptlrpc_request *req,
2327 struct ptlrpc_bulk_desc *desc)
2329 struct ptlrpc_svc_ctx *ctx;
2332 LASSERT(req->rq_bulk_write);
2335 * if it's in privacy mode, transferred should >= expected; otherwise
2336 * transferred should == expected.
2338 if (desc->bd_nob_transferred < desc->bd_nob ||
2339 (desc->bd_nob_transferred > desc->bd_nob &&
2340 SPTLRPC_FLVR_BULK_SVC(req->rq_flvr.sf_rpc) !=
2341 SPTLRPC_BULK_SVC_PRIV)) {
2342 DEBUG_REQ(D_ERROR, req, "truncated bulk GET %d(%d)",
2343 desc->bd_nob_transferred, desc->bd_nob);
2347 if (!req->rq_pack_bulk)
2350 ctx = req->rq_svc_ctx;
2351 if (ctx->sc_policy->sp_sops->unwrap_bulk) {
2352 rc = ctx->sc_policy->sp_sops->unwrap_bulk(req, desc);
2354 CERROR("error unwrap bulk: %d\n", rc);
2357 /* return 0 to allow reply be sent */
2360 EXPORT_SYMBOL(sptlrpc_svc_unwrap_bulk);
2363 * Prepare buffers for incoming bulk write.
2365 int sptlrpc_svc_prep_bulk(struct ptlrpc_request *req,
2366 struct ptlrpc_bulk_desc *desc)
2368 struct ptlrpc_svc_ctx *ctx;
2370 LASSERT(req->rq_bulk_write);
2372 if (!req->rq_pack_bulk)
2375 ctx = req->rq_svc_ctx;
2376 if (ctx->sc_policy->sp_sops->prep_bulk)
2377 return ctx->sc_policy->sp_sops->prep_bulk(req, desc);
2381 EXPORT_SYMBOL(sptlrpc_svc_prep_bulk);
2383 /****************************************
2384 * user descriptor helpers *
2385 ****************************************/
2387 int sptlrpc_current_user_desc_size(void)
2392 ngroups = current_ngroups;
2394 if (ngroups > LUSTRE_MAX_GROUPS)
2395 ngroups = LUSTRE_MAX_GROUPS;
2399 return sptlrpc_user_desc_size(ngroups);
2401 EXPORT_SYMBOL(sptlrpc_current_user_desc_size);
2403 int sptlrpc_pack_user_desc(struct lustre_msg *msg, int offset)
2405 struct ptlrpc_user_desc *pud;
2407 pud = lustre_msg_buf(msg, offset, 0);
2409 pud->pud_uid = cfs_curproc_uid();
2410 pud->pud_gid = cfs_curproc_gid();
2411 pud->pud_fsuid = cfs_curproc_fsuid();
2412 pud->pud_fsgid = cfs_curproc_fsgid();
2413 pud->pud_cap = cfs_curproc_cap_pack();
2414 pud->pud_ngroups = (msg->lm_buflens[offset] - sizeof(*pud)) / 4;
2418 if (pud->pud_ngroups > current_ngroups)
2419 pud->pud_ngroups = current_ngroups;
2420 memcpy(pud->pud_groups, current_cred()->group_info->blocks[0],
2421 pud->pud_ngroups * sizeof(__u32));
2422 task_unlock(current);
2427 EXPORT_SYMBOL(sptlrpc_pack_user_desc);
2429 int sptlrpc_unpack_user_desc(struct lustre_msg *msg, int offset, int swabbed)
2431 struct ptlrpc_user_desc *pud;
2434 pud = lustre_msg_buf(msg, offset, sizeof(*pud));
2439 __swab32s(&pud->pud_uid);
2440 __swab32s(&pud->pud_gid);
2441 __swab32s(&pud->pud_fsuid);
2442 __swab32s(&pud->pud_fsgid);
2443 __swab32s(&pud->pud_cap);
2444 __swab32s(&pud->pud_ngroups);
2447 if (pud->pud_ngroups > LUSTRE_MAX_GROUPS) {
2448 CERROR("%u groups is too large\n", pud->pud_ngroups);
2452 if (sizeof(*pud) + pud->pud_ngroups * sizeof(__u32) >
2453 msg->lm_buflens[offset]) {
2454 CERROR("%u groups are claimed but bufsize only %u\n",
2455 pud->pud_ngroups, msg->lm_buflens[offset]);
2460 for (i = 0; i < pud->pud_ngroups; i++)
2461 __swab32s(&pud->pud_groups[i]);
2466 EXPORT_SYMBOL(sptlrpc_unpack_user_desc);
2468 /****************************************
2470 ****************************************/
2472 const char * sec2target_str(struct ptlrpc_sec *sec)
2474 if (!sec || !sec->ps_import || !sec->ps_import->imp_obd)
2476 if (sec_is_reverse(sec))
2478 return obd_uuid2str(&sec->ps_import->imp_obd->u.cli.cl_target_uuid);
2480 EXPORT_SYMBOL(sec2target_str);
2483 * return true if the bulk data is protected
2485 int sptlrpc_flavor_has_bulk(struct sptlrpc_flavor *flvr)
2487 switch (SPTLRPC_FLVR_BULK_SVC(flvr->sf_rpc)) {
2488 case SPTLRPC_BULK_SVC_INTG:
2489 case SPTLRPC_BULK_SVC_PRIV:
2495 EXPORT_SYMBOL(sptlrpc_flavor_has_bulk);
2497 /****************************************
2498 * crypto API helper/alloc blkciper *
2499 ****************************************/
2501 /****************************************
2502 * initialize/finalize *
2503 ****************************************/
2505 int __init sptlrpc_init(void)
2509 cfs_rwlock_init(&policy_lock);
2511 rc = sptlrpc_gc_init();
2515 rc = sptlrpc_conf_init();
2519 rc = sptlrpc_enc_pool_init();
2523 rc = sptlrpc_null_init();
2527 rc = sptlrpc_plain_init();
2531 rc = sptlrpc_lproc_init();
2538 sptlrpc_plain_fini();
2540 sptlrpc_null_fini();
2542 sptlrpc_enc_pool_fini();
2544 sptlrpc_conf_fini();
2551 void __exit sptlrpc_fini(void)
2553 sptlrpc_lproc_fini();
2554 sptlrpc_plain_fini();
2555 sptlrpc_null_fini();
2556 sptlrpc_enc_pool_fini();
2557 sptlrpc_conf_fini();