lustre/ptlrpc/gss/gss_cli_upcall.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2006 Cluster File Systems, Inc.
   5  *   Author: Eric Mei <ericm@clusterfs.com>
   6  *
   7  *   This file is part of the Lustre file system, http://www.lustre.org
   8  *   Lustre is a trademark of Cluster File Systems, Inc.
   9  *
  10  *   You may have signed or agreed to another license before downloading
  11  *   this software.  If so, you are bound by the terms and conditions
  12  *   of that agreement, and the following does not apply to you.  See the
  13  *   LICENSE file included with this distribution for more information.
  14  *
  15  *   If you did not agree to a different license, then this copy of Lustre
  16  *   is open source software; you can redistribute it and/or modify it
  17  *   under the terms of version 2 of the GNU General Public License as
  18  *   published by the Free Software Foundation.
  19  *
  20  *   In either case, Lustre is distributed in the hope that it will be
  21  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  22  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *   license text for more details.
  24  *
  25  */
  26
  27 #ifndef EXPORT_SYMTAB
  28 # define EXPORT_SYMTAB
  29 #endif
  30 #define DEBUG_SUBSYSTEM S_SEC
  31 #ifdef __KERNEL__
  32 #include <linux/init.h>
  33 #include <linux/module.h>
  34 #include <linux/slab.h>
  35 #include <linux/dcache.h>
  36 #include <linux/fs.h>
  37 #include <linux/mutex.h>
  38 #include <linux/random.h>
  39 #else
  40 #include <liblustre.h>
  41 #endif
  42
  43 #include <obd.h>
  44 #include <obd_class.h>
  45 #include <obd_support.h>
  46 #include <lustre/lustre_idl.h>
  47 #include <lustre_net.h>
  48 #include <lustre_import.h>
  49 #include <lustre_sec.h>
  50
  51 #include "gss_err.h"
  52 #include "gss_internal.h"
  53 #include "gss_api.h"
  54
  55 /**********************************************
  56  * gss context init/fini helper               *
  57  **********************************************/
  58
  59 static
  60 int ctx_init_pack_request(struct obd_import *imp,
  61                           struct ptlrpc_request *req,
  62                           int lustre_srv,
  63                           uid_t uid, gid_t gid,
  64                           long token_size,
  65                           char __user *token)
  66 {
  67         struct lustre_msg       *msg = req->rq_reqbuf;
  68         struct gss_sec          *gsec;
  69         struct gss_header       *ghdr;
  70         struct ptlrpc_user_desc *pud;
  71         __u32                   *p, size, offset = 2;
  72         rawobj_t                 obj;
  73
  74         LASSERT(msg->lm_bufcount <= 4);
  75         LASSERT(req->rq_cli_ctx);
  76         LASSERT(req->rq_cli_ctx->cc_sec);
  77
  78         /* gss hdr */
  79         ghdr = lustre_msg_buf(msg, 0, sizeof(*ghdr));
  80         ghdr->gh_version = PTLRPC_GSS_VERSION;
  81         ghdr->gh_flags = 0;
  82         ghdr->gh_proc = PTLRPC_GSS_PROC_INIT;
  83         ghdr->gh_seq = 0;
  84         ghdr->gh_svc = SPTLRPC_SVC_NULL;
  85         ghdr->gh_handle.len = 0;
  86
  87         /* fix the user desc */
  88         if (req->rq_pack_udesc) {
  89                 ghdr->gh_flags |= LUSTRE_GSS_PACK_USER;
  90
  91                 pud = lustre_msg_buf(msg, offset, sizeof(*pud));
  92                 LASSERT(pud);
  93                 pud->pud_uid = pud->pud_fsuid = uid;
  94                 pud->pud_gid = pud->pud_fsgid = gid;
  95                 pud->pud_cap = 0;
  96                 pud->pud_ngroups = 0;
  97                 offset++;
  98         }
  99
 100         /* security payload */
 101         p = lustre_msg_buf(msg, offset, 0);
 102         size = msg->lm_buflens[offset];
 103         LASSERT(p);
 104
 105         /* 1. lustre svc type */
 106         LASSERT(size > 4);
 107         *p++ = cpu_to_le32(lustre_srv);
 108         size -= 4;
 109
 110         /* 2. target uuid */
 111         obj.len = strlen(imp->imp_obd->u.cli.cl_target_uuid.uuid) + 1;
 112         obj.data = imp->imp_obd->u.cli.cl_target_uuid.uuid;
 113         if (rawobj_serialize(&obj, &p, &size))
 114                 LBUG();
 115
 116         /* 3. reverse context handle. actually only needed by root user,
 117          *    but we send it anyway. */
 118         gsec = sec2gsec(req->rq_cli_ctx->cc_sec);
 119         obj.len = sizeof(gsec->gs_rvs_hdl);
 120         obj.data = (__u8 *) &gsec->gs_rvs_hdl;
 121         if (rawobj_serialize(&obj, &p, &size))
 122                 LBUG();
 123
 124         /* 4. now the token */
 125         LASSERT(size >= (sizeof(__u32) + token_size));
 126         *p++ = cpu_to_le32(((__u32) token_size));
 127         if (copy_from_user(p, token, token_size)) {
 128                 CERROR("can't copy token\n");
 129                 return -EFAULT;
 130         }
 131         size -= sizeof(__u32) + size_round4(token_size);
 132
 133         req->rq_reqdata_len = lustre_shrink_msg(req->rq_reqbuf, offset,
 134                                                 msg->lm_buflens[offset] - size, 0);
 135         return 0;
 136 }
 137
 138 static
 139 int ctx_init_parse_reply(struct lustre_msg *msg,
 140                          char __user *outbuf, long outlen)
 141 {
 142         struct gss_rep_header   *ghdr;
 143         __u32                    obj_len, round_len;
 144         __u32                    status, effective = 0;
 145
 146         if (msg->lm_bufcount != 3) {
 147                 CERROR("unexpected bufcount %u\n", msg->lm_bufcount);
 148                 return -EPROTO;
 149         }
 150
 151         ghdr = (struct gss_rep_header *) gss_swab_header(msg, 0);
 152         if (ghdr == NULL) {
 153                 CERROR("unable to extract gss reply header\n");
 154                 return -EPROTO;
 155         }
 156
 157         if (ghdr->gh_version != PTLRPC_GSS_VERSION) {
 158                 CERROR("invalid gss version %u\n", ghdr->gh_version);
 159                 return -EPROTO;
 160         }
 161
 162         if (outlen < (4 + 2) * 4 + size_round4(ghdr->gh_handle.len) +
 163                      size_round4(msg->lm_buflens[2])) {
 164                 CERROR("output buffer size %ld too small\n", outlen);
 165                 return -EFAULT;
 166         }
 167
 168         status = 0;
 169         effective = 0;
 170
 171         if (copy_to_user(outbuf, &status, 4))
 172                 return -EFAULT;
 173         outbuf += 4;
 174         if (copy_to_user(outbuf, &ghdr->gh_major, 4))
 175                 return -EFAULT;
 176         outbuf += 4;
 177         if (copy_to_user(outbuf, &ghdr->gh_minor, 4))
 178                 return -EFAULT;
 179         outbuf += 4;
 180         if (copy_to_user(outbuf, &ghdr->gh_seqwin, 4))
 181                 return -EFAULT;
 182         outbuf += 4;
 183         effective += 4 * 4;
 184
 185         /* handle */
 186         obj_len = ghdr->gh_handle.len;
 187         round_len = (obj_len + 3) & ~ 3;
 188         if (copy_to_user(outbuf, &obj_len, 4))
 189                 return -EFAULT;
 190         outbuf += 4;
 191         if (copy_to_user(outbuf, (char *) ghdr->gh_handle.data, round_len))
 192                 return -EFAULT;
 193         outbuf += round_len;
 194         effective += 4 + round_len;
 195
 196         /* out token */
 197         obj_len = msg->lm_buflens[2];
 198         round_len = (obj_len + 3) & ~ 3;
 199         if (copy_to_user(outbuf, &obj_len, 4))
 200                 return -EFAULT;
 201         outbuf += 4;
 202         if (copy_to_user(outbuf, lustre_msg_buf(msg, 2, 0), round_len))
 203                 return -EFAULT;
 204         outbuf += round_len;
 205         effective += 4 + round_len;
 206
 207         return effective;
 208 }
 209
 210 /* XXX move to where lgssd could see */
 211 struct lgssd_ioctl_param {
 212         int             version;        /* in   */
 213         int             secid;          /* in   */
 214         char           *uuid;           /* in   */
 215         int             lustre_svc;     /* in   */
 216         uid_t           uid;            /* in   */
 217         gid_t           gid;            /* in   */
 218         long            send_token_size;/* in   */
 219         char           *send_token;     /* in   */
 220         long            reply_buf_size; /* in   */
 221         char           *reply_buf;      /* in   */
 222         long            status;         /* out  */
 223         long            reply_length;   /* out  */
 224 };
 225
 226 int gss_do_ctx_init_rpc(__user char *buffer, unsigned long count)
 227 {
 228         struct obd_import        *imp;
 229         struct ptlrpc_request    *req;
 230         struct lgssd_ioctl_param  param;
 231         struct obd_device        *obd;
 232         char                      obdname[64];
 233         long                      lsize;
 234         int                       lmsg_size = sizeof(struct ptlrpc_body);
 235         int                       rc;
 236
 237         if (count != sizeof(param)) {
 238                 CERROR("ioctl size %lu, expect %lu, please check lgssd version\n",
 239                         count, (unsigned long) sizeof(param));
 240                 RETURN(-EINVAL);
 241         }
 242         if (copy_from_user(&param, buffer, sizeof(param))) {
 243                 CERROR("failed copy data from lgssd\n");
 244                 RETURN(-EFAULT);
 245         }
 246
 247         if (param.version != GSSD_INTERFACE_VERSION) {
 248                 CERROR("gssd interface version %d (expect %d)\n",
 249                         param.version, GSSD_INTERFACE_VERSION);
 250                 RETURN(-EINVAL);
 251         }
 252
 253         /* take name */
 254         if (strncpy_from_user(obdname, param.uuid, sizeof(obdname)) <= 0) {
 255                 CERROR("Invalid obdname pointer\n");
 256                 RETURN(-EFAULT);
 257         }
 258
 259         obd = class_name2obd(obdname);
 260         if (!obd) {
 261                 CERROR("no such obd %s\n", obdname);
 262                 RETURN(-EINVAL);
 263         }
 264
 265         imp = class_import_get(obd->u.cli.cl_import);
 266         LASSERT(imp->imp_sec);
 267
 268         /* force this import to use v2 msg */
 269         imp->imp_msg_magic = LUSTRE_MSG_MAGIC_V2;
 270
 271         req = ptlrpc_prep_req(imp, LUSTRE_OBD_VERSION, SEC_CTX_INIT,
 272                               1, &lmsg_size, NULL);
 273         if (!req) {
 274                 param.status = -ENOMEM;
 275                 goto out_copy;
 276         }
 277
 278         if (req->rq_cli_ctx->cc_sec->ps_id != param.secid) {
 279                 CWARN("original secid %d, now has changed to %d, "
 280                       "cancel this negotiation\n", param.secid,
 281                       req->rq_cli_ctx->cc_sec->ps_id);
 282                 param.status = -EINVAL;
 283                 goto out_copy;
 284         }
 285
 286         /* get token */
 287         rc = ctx_init_pack_request(imp, req,
 288                                    param.lustre_svc,
 289                                    param.uid, param.gid,
 290                                    param.send_token_size,
 291                                    param.send_token);
 292         if (rc) {
 293                 param.status = rc;
 294                 goto out_copy;
 295         }
 296
 297         req->rq_replen = lustre_msg_size_v2(1, &lmsg_size);
 298
 299         rc = ptlrpc_queue_wait(req);
 300         if (rc) {
 301                 /* If any _real_ denial be made, we expect server return
 302                  * -EACCES reply or return success but indicate gss error
 303                  * inside reply messsage. All other errors are treated as
 304                  * timeout, caller might try the negotiation repeatedly,
 305                  * leave recovery decisions to general ptlrpc layer.
 306                  *
 307                  * FIXME maybe some other error code shouldn't be treated
 308                  * as timeout. */
 309                 param.status = rc;
 310                 if (rc != -EACCES)
 311                         param.status = -ETIMEDOUT;
 312                 goto out_copy;
 313         }
 314
 315         lsize = ctx_init_parse_reply(req->rq_repbuf,
 316                                      param.reply_buf, param.reply_buf_size);
 317         if (lsize < 0) {
 318                 param.status = (int) lsize;
 319                 goto out_copy;
 320         }
 321
 322         param.status = 0;
 323         param.reply_length = lsize;
 324
 325 out_copy:
 326         if (copy_to_user(buffer, &param, sizeof(param)))
 327                 rc = -EFAULT;
 328         else
 329                 rc = 0;
 330
 331         class_import_put(imp);
 332         ptlrpc_req_finished(req);
 333         RETURN(rc);
 334 }
 335
 336 int gss_do_ctx_fini_rpc(struct gss_cli_ctx *gctx)
 337 {
 338         struct ptlrpc_cli_ctx   *ctx = &gctx->gc_base;
 339         struct obd_import       *imp = ctx->cc_sec->ps_import;
 340         struct ptlrpc_request   *req;
 341         struct ptlrpc_user_desc *pud;
 342         int                      buflens = sizeof(struct ptlrpc_body);
 343         int                      rc;
 344         ENTRY;
 345
 346         LASSERT(atomic_read(&ctx->cc_refcount) > 0);
 347
 348         if (cli_ctx_is_error(ctx) || !cli_ctx_is_uptodate(ctx)) {
 349                 CDEBUG(D_SEC, "ctx %p(%u->%s) not uptodate, "
 350                        "don't send destroy rpc\n", ctx,
 351                        ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 352                 RETURN(0);
 353         }
 354
 355         might_sleep();
 356
 357         CWARN("%s ctx %p idx "LPX64" (%u->%s)\n",
 358               sec_is_reverse(ctx->cc_sec) ?
 359               "server finishing reverse" : "client finishing forward",
 360               ctx, gss_handle_to_u64(&gctx->gc_handle),
 361               ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 362
 363         gctx->gc_proc = PTLRPC_GSS_PROC_DESTROY;
 364
 365         req = ptlrpc_prep_req_pool(imp, LUSTRE_OBD_VERSION, SEC_CTX_FINI,
 366                                    1, &buflens, NULL, NULL, ctx);
 367         if (!req) {
 368                 CWARN("ctx %p(%u): fail to prepare rpc, destroy locally\n",
 369                       ctx, ctx->cc_vcred.vc_uid);
 370                 GOTO(out, rc = -ENOMEM);
 371         }
 372
 373         /* fix the user desc */
 374         if (req->rq_pack_udesc) {
 375                 /* we rely the fact that this request is in AUTH mode,
 376                  * and user_desc at offset 2. */
 377                 pud = lustre_msg_buf(req->rq_reqbuf, 2, sizeof(*pud));
 378                 LASSERT(pud);
 379                 pud->pud_uid = pud->pud_fsuid = ctx->cc_vcred.vc_uid;
 380                 pud->pud_gid = pud->pud_fsgid = ctx->cc_vcred.vc_gid;
 381                 pud->pud_cap = 0;
 382                 pud->pud_ngroups = 0;
 383         }
 384
 385         req->rq_phase = RQ_PHASE_RPC;
 386         rc = ptl_send_rpc(req, 1);
 387         if (rc) {
 388                 CWARN("ctx %p(%u->%s): rpc error %d, destroy locally\n",
 389                       ctx, ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec),
 390                       rc);
 391         }
 392
 393         ptlrpc_req_finished(req);
 394 out:
 395         RETURN(rc);
 396 }
 397
 398 int __init gss_init_cli_upcall(void)
 399 {
 400         return 0;
 401 }
 402
 403 void __exit gss_exit_cli_upcall(void)
 404 {
 405 }