1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2006 Cluster File Systems, Inc.
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 # define EXPORT_SYMTAB
25 #define DEBUG_SUBSYSTEM S_SEC
28 #include <liblustre.h>
31 #include <obd_support.h>
32 #include <obd_class.h>
33 #include <lustre_net.h>
34 #include <lustre_sec.h>
36 static struct ptlrpc_sec_policy plain_policy;
37 static struct ptlrpc_sec plain_sec;
38 static struct ptlrpc_cli_ctx plain_cli_ctx;
39 static struct ptlrpc_svc_ctx plain_svc_ctx;
42 int plain_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
44 /* should never reach here */
50 int plain_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
52 struct lustre_msg_v2 *msg = req->rq_reqbuf;
55 msg->lm_secflvr = req->rq_sec_flavor;
56 req->rq_reqdata_len = lustre_msg_size_v2(msg->lm_bufcount,
62 int plain_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
64 struct lustre_msg *msg = req->rq_repbuf;
67 if (SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor)) {
68 if (msg->lm_bufcount != 2) {
69 CERROR("Protocol error: invalid buf count %d\n",
74 if (bulk_sec_desc_unpack(msg, 1)) {
75 CERROR("Mal-formed bulk checksum reply\n");
80 req->rq_repmsg = lustre_msg_buf(msg, 0, 0);
81 req->rq_replen = msg->lm_buflens[0];
86 int plain_cli_wrap_bulk(struct ptlrpc_cli_ctx *ctx,
87 struct ptlrpc_request *req,
88 struct ptlrpc_bulk_desc *desc)
90 struct sec_flavor_config *conf;
92 LASSERT(req->rq_import);
93 LASSERT(SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor));
94 LASSERT(req->rq_reqbuf->lm_bufcount >= 2);
96 conf = &req->rq_import->imp_obd->u.cli.cl_sec_conf;
97 return bulk_csum_cli_request(desc, req->rq_bulk_read,
100 req->rq_reqbuf->lm_bufcount - 1);
104 int plain_cli_unwrap_bulk(struct ptlrpc_cli_ctx *ctx,
105 struct ptlrpc_request *req,
106 struct ptlrpc_bulk_desc *desc)
108 LASSERT(SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor));
109 LASSERT(req->rq_reqbuf->lm_bufcount >= 2);
110 LASSERT(req->rq_repbuf->lm_bufcount >= 2);
112 return bulk_csum_cli_reply(desc, req->rq_bulk_read,
114 req->rq_reqbuf->lm_bufcount - 1,
116 req->rq_repbuf->lm_bufcount - 1);
119 static struct ptlrpc_ctx_ops plain_ctx_ops = {
120 .refresh = plain_ctx_refresh,
121 .sign = plain_ctx_sign,
122 .verify = plain_ctx_verify,
123 .wrap_bulk = plain_cli_wrap_bulk,
124 .unwrap_bulk = plain_cli_unwrap_bulk,
127 static struct ptlrpc_svc_ctx plain_svc_ctx = {
128 .sc_refcount = ATOMIC_INIT(1),
129 .sc_policy = &plain_policy,
133 struct ptlrpc_sec* plain_create_sec(struct obd_import *imp,
134 struct ptlrpc_svc_ctx *ctx,
139 LASSERT(SEC_FLAVOR_POLICY(flavor) == SPTLRPC_POLICY_PLAIN);
144 void plain_destroy_sec(struct ptlrpc_sec *sec)
147 LASSERT(sec == &plain_sec);
152 struct ptlrpc_cli_ctx *plain_lookup_ctx(struct ptlrpc_sec *sec,
153 struct vfs_cred *vcred)
156 atomic_inc(&plain_cli_ctx.cc_refcount);
157 RETURN(&plain_cli_ctx);
161 int plain_alloc_reqbuf(struct ptlrpc_sec *sec,
162 struct ptlrpc_request *req,
165 struct sec_flavor_config *conf;
166 int bufcnt = 1, buflens[2], alloc_len;
169 buflens[0] = msgsize;
171 if (SEC_FLAVOR_HAS_USER(req->rq_sec_flavor))
172 buflens[bufcnt++] = sptlrpc_current_user_desc_size();
174 if (SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor)) {
175 LASSERT(req->rq_bulk_read || req->rq_bulk_write);
177 conf = &req->rq_import->imp_obd->u.cli.cl_sec_conf;
178 buflens[bufcnt++] = bulk_sec_desc_size(conf->sfc_bulk_csum, 1,
182 alloc_len = lustre_msg_size_v2(bufcnt, buflens);
184 if (!req->rq_reqbuf) {
185 LASSERT(!req->rq_pool);
187 alloc_len = size_roundup_power2(alloc_len);
188 OBD_ALLOC(req->rq_reqbuf, alloc_len);
192 req->rq_reqbuf_len = alloc_len;
194 LASSERT(req->rq_pool);
195 LASSERT(req->rq_reqbuf_len >= alloc_len);
196 memset(req->rq_reqbuf, 0, alloc_len);
199 lustre_init_msg_v2(req->rq_reqbuf, bufcnt, buflens, NULL);
200 req->rq_reqmsg = lustre_msg_buf_v2(req->rq_reqbuf, 0, 0);
202 if (SEC_FLAVOR_HAS_USER(req->rq_sec_flavor))
203 sptlrpc_pack_user_desc(req->rq_reqbuf, 1);
209 void plain_free_reqbuf(struct ptlrpc_sec *sec,
210 struct ptlrpc_request *req)
214 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
215 req->rq_reqbuf = NULL;
216 req->rq_reqbuf_len = 0;
222 int plain_alloc_repbuf(struct ptlrpc_sec *sec,
223 struct ptlrpc_request *req,
226 struct sec_flavor_config *conf;
227 int bufcnt = 1, buflens[2], alloc_len;
230 buflens[0] = msgsize;
232 if (SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor)) {
233 LASSERT(req->rq_bulk_read || req->rq_bulk_write);
235 conf = &req->rq_import->imp_obd->u.cli.cl_sec_conf;
236 buflens[bufcnt++] = bulk_sec_desc_size(conf->sfc_bulk_csum, 0,
240 alloc_len = lustre_msg_size_v2(bufcnt, buflens);
241 alloc_len = size_roundup_power2(alloc_len);
243 OBD_ALLOC(req->rq_repbuf, alloc_len);
247 req->rq_repbuf_len = alloc_len;
252 void plain_free_repbuf(struct ptlrpc_sec *sec,
253 struct ptlrpc_request *req)
256 OBD_FREE(req->rq_repbuf, req->rq_repbuf_len);
257 req->rq_repbuf = NULL;
258 req->rq_repbuf_len = 0;
263 int plain_enlarge_reqbuf(struct ptlrpc_sec *sec,
264 struct ptlrpc_request *req,
265 int segment, int newsize)
267 struct lustre_msg *newbuf;
269 int newmsg_size, newbuf_size;
272 /* embedded msg always at seg 0 */
273 LASSERT(req->rq_reqbuf);
274 LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
275 LASSERT(lustre_msg_buf(req->rq_reqbuf, 0, 0) == req->rq_reqmsg);
277 /* compute new embedded msg size. */
278 oldsize = req->rq_reqmsg->lm_buflens[segment];
279 req->rq_reqmsg->lm_buflens[segment] = newsize;
280 newmsg_size = lustre_msg_size_v2(req->rq_reqmsg->lm_bufcount,
281 req->rq_reqmsg->lm_buflens);
282 req->rq_reqmsg->lm_buflens[segment] = oldsize;
284 /* compute new wrapper msg size. */
285 oldsize = req->rq_reqbuf->lm_buflens[0];
286 req->rq_reqbuf->lm_buflens[0] = newmsg_size;
287 newbuf_size = lustre_msg_size_v2(req->rq_reqbuf->lm_bufcount,
288 req->rq_reqbuf->lm_buflens);
289 req->rq_reqbuf->lm_buflens[0] = oldsize;
291 /* request from pool should always have enough buffer */
292 LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newbuf_size);
294 if (req->rq_reqbuf_len < newbuf_size) {
295 newbuf_size = size_roundup_power2(newbuf_size);
297 OBD_ALLOC(newbuf, newbuf_size);
301 memcpy(newbuf, req->rq_reqbuf, req->rq_reqbuf_len);
303 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
304 req->rq_reqbuf = newbuf;
305 req->rq_reqbuf_len = newbuf_size;
306 req->rq_reqmsg = lustre_msg_buf(req->rq_reqbuf, 0, 0);
309 _sptlrpc_enlarge_msg_inplace(req->rq_reqbuf, 0, newmsg_size);
310 _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
312 req->rq_reqlen = newmsg_size;
317 int plain_accept(struct ptlrpc_request *req)
319 struct lustre_msg *msg = req->rq_reqbuf;
323 LASSERT(SEC_FLAVOR_POLICY(req->rq_sec_flavor) == SPTLRPC_POLICY_PLAIN);
325 if (SEC_FLAVOR_RPC(req->rq_sec_flavor) != SPTLRPC_FLVR_PLAIN) {
326 CERROR("Invalid flavor 0x%x\n", req->rq_sec_flavor);
330 if (SEC_FLAVOR_HAS_USER(req->rq_sec_flavor)) {
331 if (msg->lm_bufcount < ++bufcnt) {
332 CERROR("Protocal error: too small buf count %d\n",
337 if (sptlrpc_unpack_user_desc(msg, bufcnt - 1)) {
338 CERROR("Mal-formed user descriptor\n");
342 req->rq_user_desc = lustre_msg_buf(msg, bufcnt - 1, 0);
345 if (SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor)) {
346 if (msg->lm_bufcount != ++bufcnt) {
347 CERROR("Protocal error: invalid buf count %d\n",
352 if (bulk_sec_desc_unpack(msg, bufcnt - 1)) {
353 CERROR("Mal-formed bulk checksum request\n");
358 req->rq_reqmsg = lustre_msg_buf(msg, 0, 0);
359 req->rq_reqlen = msg->lm_buflens[0];
361 req->rq_svc_ctx = &plain_svc_ctx;
362 atomic_inc(&req->rq_svc_ctx->sc_refcount);
368 int plain_alloc_rs(struct ptlrpc_request *req, int msgsize)
370 struct ptlrpc_reply_state *rs;
371 struct ptlrpc_bulk_sec_desc *bsd;
372 int bufcnt = 1, buflens[2];
373 int rs_size = sizeof(*rs);
376 LASSERT(msgsize % 8 == 0);
378 buflens[0] = msgsize;
379 if (SEC_FLAVOR_HAS_BULK(req->rq_sec_flavor) &&
380 (req->rq_bulk_read || req->rq_bulk_write)) {
381 bsd = lustre_msg_buf(req->rq_reqbuf,
382 req->rq_reqbuf->lm_bufcount - 1,
386 buflens[bufcnt++] = bulk_sec_desc_size(bsd->bsd_csum_alg, 0,
389 rs_size += lustre_msg_size_v2(bufcnt, buflens);
391 rs = req->rq_reply_state;
395 LASSERT(rs->rs_size >= rs_size);
397 OBD_ALLOC(rs, rs_size);
401 rs->rs_size = rs_size;
404 rs->rs_svc_ctx = req->rq_svc_ctx;
405 atomic_inc(&req->rq_svc_ctx->sc_refcount);
406 rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
407 rs->rs_repbuf_len = rs_size - sizeof(*rs);
409 lustre_init_msg_v2(rs->rs_repbuf, bufcnt, buflens, NULL);
410 rs->rs_msg = lustre_msg_buf_v2(rs->rs_repbuf, 0, 0);
412 req->rq_reply_state = rs;
417 void plain_free_rs(struct ptlrpc_reply_state *rs)
421 LASSERT(atomic_read(&rs->rs_svc_ctx->sc_refcount) > 1);
422 atomic_dec(&rs->rs_svc_ctx->sc_refcount);
424 if (!rs->rs_prealloc)
425 OBD_FREE(rs, rs->rs_size);
430 int plain_authorize(struct ptlrpc_request *req)
432 struct ptlrpc_reply_state *rs = req->rq_reply_state;
433 struct lustre_msg_v2 *msg = rs->rs_repbuf;
440 if (req->rq_replen != msg->lm_buflens[0])
441 len = lustre_shrink_msg(msg, 0, req->rq_replen, 1);
443 len = lustre_msg_size_v2(msg->lm_bufcount, msg->lm_buflens);
445 msg->lm_secflvr = req->rq_sec_flavor;
446 rs->rs_repdata_len = len;
451 int plain_svc_unwrap_bulk(struct ptlrpc_request *req,
452 struct ptlrpc_bulk_desc *desc)
454 struct ptlrpc_reply_state *rs = req->rq_reply_state;
458 return bulk_csum_svc(desc, req->rq_bulk_read,
459 req->rq_reqbuf, req->rq_reqbuf->lm_bufcount - 1,
460 rs->rs_repbuf, rs->rs_repbuf->lm_bufcount - 1);
464 int plain_svc_wrap_bulk(struct ptlrpc_request *req,
465 struct ptlrpc_bulk_desc *desc)
467 struct ptlrpc_reply_state *rs = req->rq_reply_state;
471 return bulk_csum_svc(desc, req->rq_bulk_read,
472 req->rq_reqbuf, req->rq_reqbuf->lm_bufcount - 1,
473 rs->rs_repbuf, rs->rs_repbuf->lm_bufcount - 1);
476 static struct ptlrpc_sec_cops plain_sec_cops = {
477 .create_sec = plain_create_sec,
478 .destroy_sec = plain_destroy_sec,
479 .lookup_ctx = plain_lookup_ctx,
480 .alloc_reqbuf = plain_alloc_reqbuf,
481 .alloc_repbuf = plain_alloc_repbuf,
482 .free_reqbuf = plain_free_reqbuf,
483 .free_repbuf = plain_free_repbuf,
484 .enlarge_reqbuf = plain_enlarge_reqbuf,
487 static struct ptlrpc_sec_sops plain_sec_sops = {
488 .accept = plain_accept,
489 .alloc_rs = plain_alloc_rs,
490 .authorize = plain_authorize,
491 .free_rs = plain_free_rs,
492 .unwrap_bulk = plain_svc_unwrap_bulk,
493 .wrap_bulk = plain_svc_wrap_bulk,
496 static struct ptlrpc_sec_policy plain_policy = {
497 .sp_owner = THIS_MODULE,
498 .sp_name = "sec.plain",
499 .sp_policy = SPTLRPC_POLICY_PLAIN,
500 .sp_cops = &plain_sec_cops,
501 .sp_sops = &plain_sec_sops,
505 void plain_init_internal(void)
507 static HLIST_HEAD(__list);
509 plain_sec.ps_policy = &plain_policy;
510 atomic_set(&plain_sec.ps_refcount, 1); /* always busy */
511 plain_sec.ps_import = NULL;
512 plain_sec.ps_flavor = SPTLRPC_FLVR_PLAIN;
513 plain_sec.ps_flags = 0;
514 plain_sec.ps_gc_interval = 0;
515 plain_sec.ps_gc_next = 0;
516 spin_lock_init(&plain_sec.ps_lock);
517 plain_sec.ps_ccache_size = 1;
518 plain_sec.ps_ccache = &__list;
519 atomic_set(&plain_sec.ps_busy, 1); /* for "plain_cli_ctx" */
521 hlist_add_head(&plain_cli_ctx.cc_hash, &__list);
522 atomic_set(&plain_cli_ctx.cc_refcount, 1); /* for hash */
523 plain_cli_ctx.cc_sec = &plain_sec;
524 plain_cli_ctx.cc_ops = &plain_ctx_ops;
525 plain_cli_ctx.cc_expire = 0;
526 plain_cli_ctx.cc_flags = PTLRPC_CTX_HASHED | PTLRPC_CTX_ETERNAL |
528 plain_cli_ctx.cc_vcred.vc_uid = 0;
529 spin_lock_init(&plain_cli_ctx.cc_lock);
530 INIT_LIST_HEAD(&plain_cli_ctx.cc_req_list);
533 int sptlrpc_plain_init(void)
537 plain_init_internal();
539 rc = sptlrpc_register_policy(&plain_policy);
541 CERROR("failed to register sec.plain: %d\n", rc);
546 void sptlrpc_plain_fini(void)
550 rc = sptlrpc_unregister_policy(&plain_policy);
552 CERROR("cannot unregister sec.plain: %d\n", rc);