lustre/ptlrpc/gss/gss_cli_upcall.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/ptlrpc/gss/gss_cli_upcall.c
  33  *
  34  * Author: Eric Mei <ericm@clusterfs.com>
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_SEC
  38 #include <linux/init.h>
  39 #include <linux/module.h>
  40 #include <linux/slab.h>
  41 #include <linux/dcache.h>
  42 #include <linux/fs.h>
  43 #include <linux/mutex.h>
  44
  45 #include <obd.h>
  46 #include <obd_class.h>
  47 #include <obd_support.h>
  48 #include <lustre_net.h>
  49 #include <lustre_import.h>
  50 #include <lustre_sec.h>
  51
  52 #include "gss_err.h"
  53 #include "gss_internal.h"
  54 #include "gss_api.h"
  55
  56 /**********************************************
  57  * gss context init/fini helper               *
  58  **********************************************/
  59
  60 static
  61 int ctx_init_pack_request(struct obd_import *imp,
  62                           struct ptlrpc_request *req,
  63                           int lustre_srv,
  64                           uid_t uid, gid_t gid,
  65                           long token_size,
  66                           char __user *token)
  67 {
  68         struct lustre_msg       *msg = req->rq_reqbuf;
  69         struct gss_sec          *gsec;
  70         struct gss_header       *ghdr;
  71         struct ptlrpc_user_desc *pud;
  72         __u32                   *p, size, offset = 2;
  73         rawobj_t                 obj;
  74
  75         LASSERT(msg->lm_bufcount <= 4);
  76         LASSERT(req->rq_cli_ctx);
  77         LASSERT(req->rq_cli_ctx->cc_sec);
  78
  79         /* gss hdr */
  80         ghdr = lustre_msg_buf(msg, 0, sizeof(*ghdr));
  81         ghdr->gh_version = PTLRPC_GSS_VERSION;
  82         ghdr->gh_sp = (__u8) imp->imp_sec->ps_part;
  83         ghdr->gh_flags = 0;
  84         ghdr->gh_proc = PTLRPC_GSS_PROC_INIT;
  85         ghdr->gh_seq = 0;
  86         ghdr->gh_svc = SPTLRPC_SVC_NULL;
  87         ghdr->gh_handle.len = 0;
  88
  89         /* fix the user desc */
  90         if (req->rq_pack_udesc) {
  91                 ghdr->gh_flags |= LUSTRE_GSS_PACK_USER;
  92
  93                 pud = lustre_msg_buf(msg, offset, sizeof(*pud));
  94                 LASSERT(pud);
  95                 pud->pud_uid = pud->pud_fsuid = uid;
  96                 pud->pud_gid = pud->pud_fsgid = gid;
  97                 pud->pud_cap = 0;
  98                 pud->pud_ngroups = 0;
  99                 offset++;
 100         }
 101
 102         /* new clients are expected to set KCSUM flag */
 103         ghdr->gh_flags |= LUSTRE_GSS_PACK_KCSUM;
 104
 105         /* security payload */
 106         p = lustre_msg_buf(msg, offset, 0);
 107         size = msg->lm_buflens[offset];
 108         LASSERT(p);
 109
 110         /* 1. lustre svc type */
 111         LASSERT(size > 4);
 112         *p++ = cpu_to_le32(lustre_srv);
 113         size -= 4;
 114
 115         /* 2. target uuid */
 116         obj.len = strlen(imp->imp_obd->u.cli.cl_target_uuid.uuid) + 1;
 117         obj.data = imp->imp_obd->u.cli.cl_target_uuid.uuid;
 118         if (rawobj_serialize(&obj, &p, &size))
 119                 LBUG();
 120
 121         /* 3. reverse context handle. actually only needed by root user,
 122          *    but we send it anyway. */
 123         gsec = sec2gsec(req->rq_cli_ctx->cc_sec);
 124         obj.len = sizeof(gsec->gs_rvs_hdl);
 125         obj.data = (__u8 *) &gsec->gs_rvs_hdl;
 126         if (rawobj_serialize(&obj, &p, &size))
 127                 LBUG();
 128
 129         /* 4. now the token */
 130         LASSERT(size >= (sizeof(__u32) + token_size));
 131         *p++ = cpu_to_le32(((__u32) token_size));
 132         if (copy_from_user(p, token, token_size)) {
 133                 CERROR("can't copy token\n");
 134                 return -EFAULT;
 135         }
 136         size -= sizeof(__u32) + cfs_size_round4(token_size);
 137
 138         req->rq_reqdata_len = lustre_shrink_msg(req->rq_reqbuf, offset,
 139                                              msg->lm_buflens[offset] - size, 0);
 140         return 0;
 141 }
 142
 143 static
 144 int ctx_init_parse_reply(struct lustre_msg *msg, int swabbed,
 145                          char __user *outbuf, long outlen)
 146 {
 147         struct gss_rep_header   *ghdr;
 148         __u32                    obj_len, round_len;
 149         __u32                    status, effective = 0;
 150
 151         if (msg->lm_bufcount != 3) {
 152                 CERROR("unexpected bufcount %u\n", msg->lm_bufcount);
 153                 return -EPROTO;
 154         }
 155
 156         ghdr = (struct gss_rep_header *) gss_swab_header(msg, 0, swabbed);
 157         if (ghdr == NULL) {
 158                 CERROR("unable to extract gss reply header\n");
 159                 return -EPROTO;
 160         }
 161
 162         if (ghdr->gh_version != PTLRPC_GSS_VERSION) {
 163                 CERROR("invalid gss version %u\n", ghdr->gh_version);
 164                 return -EPROTO;
 165         }
 166
 167         if (outlen < (4 + 2) * 4 + cfs_size_round4(ghdr->gh_handle.len) +
 168                      cfs_size_round4(msg->lm_buflens[2])) {
 169                 CERROR("output buffer size %ld too small\n", outlen);
 170                 return -EFAULT;
 171         }
 172
 173         status = 0;
 174         effective = 0;
 175
 176         if (copy_to_user(outbuf, &status, 4))
 177                 return -EFAULT;
 178         outbuf += 4;
 179         if (copy_to_user(outbuf, &ghdr->gh_major, 4))
 180                 return -EFAULT;
 181         outbuf += 4;
 182         if (copy_to_user(outbuf, &ghdr->gh_minor, 4))
 183                 return -EFAULT;
 184         outbuf += 4;
 185         if (copy_to_user(outbuf, &ghdr->gh_seqwin, 4))
 186                 return -EFAULT;
 187         outbuf += 4;
 188         effective += 4 * 4;
 189
 190         /* handle */
 191         obj_len = ghdr->gh_handle.len;
 192         round_len = (obj_len + 3) & ~3;
 193         if (copy_to_user(outbuf, &obj_len, 4))
 194                 return -EFAULT;
 195         outbuf += 4;
 196         if (copy_to_user(outbuf, (char *) ghdr->gh_handle.data, round_len))
 197                 return -EFAULT;
 198         outbuf += round_len;
 199         effective += 4 + round_len;
 200
 201         /* out token */
 202         obj_len = msg->lm_buflens[2];
 203         round_len = (obj_len + 3) & ~3;
 204         if (copy_to_user(outbuf, &obj_len, 4))
 205                 return -EFAULT;
 206         outbuf += 4;
 207         if (copy_to_user(outbuf, lustre_msg_buf(msg, 2, 0), round_len))
 208                 return -EFAULT;
 209         outbuf += round_len;
 210         effective += 4 + round_len;
 211
 212         return effective;
 213 }
 214
 215 /* XXX move to where lgssd could see */
 216 struct lgssd_ioctl_param {
 217         int             version;        /* in   */
 218         int             secid;          /* in   */
 219         char __user    *uuid;           /* in   */
 220         int             lustre_svc;     /* in   */
 221         uid_t           uid;            /* in   */
 222         gid_t           gid;            /* in   */
 223         long            send_token_size;/* in   */
 224         char __user    *send_token;     /* in   */
 225         long            reply_buf_size; /* in   */
 226         char __user    *reply_buf;      /* in   */
 227         long            status;         /* out  */
 228         long            reply_length;   /* out  */
 229 };
 230
 231 int gss_do_ctx_init_rpc(char __user *buffer, unsigned long count)
 232 {
 233         struct obd_import        *imp;
 234         struct ptlrpc_request    *req;
 235         struct lgssd_ioctl_param  param;
 236         struct obd_device        *obd;
 237         char                      obdname[64];
 238         long                      lsize;
 239         int                       rc;
 240
 241         if (count != sizeof(param)) {
 242                 CERROR("ioctl size %lu, expect %lu, please check lgss_keyring "
 243                        "version\n", count, (unsigned long) sizeof(param));
 244                 RETURN(-EINVAL);
 245         }
 246         if (copy_from_user(&param, buffer, sizeof(param))) {
 247                 CERROR("failed copy data from lgssd\n");
 248                 RETURN(-EFAULT);
 249         }
 250
 251         if (param.version != GSSD_INTERFACE_VERSION) {
 252                 CERROR("gssd interface version %d (expect %d)\n",
 253                         param.version, GSSD_INTERFACE_VERSION);
 254                 RETURN(-EINVAL);
 255         }
 256
 257         /* take name */
 258         if (strncpy_from_user(obdname, param.uuid, sizeof(obdname)) <= 0) {
 259                 CERROR("Invalid obdname pointer\n");
 260                 RETURN(-EFAULT);
 261         }
 262
 263         obd = class_name2obd(obdname);
 264         if (!obd) {
 265                 CERROR("no such obd %s\n", obdname);
 266                 RETURN(-EINVAL);
 267         }
 268
 269         if (unlikely(!obd->obd_set_up)) {
 270                 CERROR("obd %s not setup\n", obdname);
 271                 RETURN(-EINVAL);
 272         }
 273
 274         spin_lock(&obd->obd_dev_lock);
 275         if (obd->obd_stopping) {
 276                 CERROR("obd %s has stopped\n", obdname);
 277                 spin_unlock(&obd->obd_dev_lock);
 278                 RETURN(-EINVAL);
 279         }
 280
 281         if (strcmp(obd->obd_type->typ_name, LUSTRE_MDC_NAME) &&
 282             strcmp(obd->obd_type->typ_name, LUSTRE_OSC_NAME) &&
 283             strcmp(obd->obd_type->typ_name, LUSTRE_MGC_NAME) &&
 284             strcmp(obd->obd_type->typ_name, LUSTRE_LWP_NAME) &&
 285             strcmp(obd->obd_type->typ_name, LUSTRE_OSP_NAME)) {
 286                 CERROR("obd %s is not a client device\n", obdname);
 287                 spin_unlock(&obd->obd_dev_lock);
 288                 RETURN(-EINVAL);
 289         }
 290         spin_unlock(&obd->obd_dev_lock);
 291
 292         down_read(&obd->u.cli.cl_sem);
 293         if (obd->u.cli.cl_import == NULL) {
 294                 CERROR("obd %s: import has gone\n", obd->obd_name);
 295                 up_read(&obd->u.cli.cl_sem);
 296                 RETURN(-EINVAL);
 297         }
 298         imp = class_import_get(obd->u.cli.cl_import);
 299         up_read(&obd->u.cli.cl_sem);
 300
 301         if (imp->imp_deactive) {
 302                 CERROR("import has been deactivated\n");
 303                 class_import_put(imp);
 304                 RETURN(-EINVAL);
 305         }
 306
 307         req = ptlrpc_request_alloc_pack(imp, &RQF_SEC_CTX, LUSTRE_OBD_VERSION,
 308                                         SEC_CTX_INIT);
 309         if (req == NULL) {
 310                 param.status = -ENOMEM;
 311                 goto out_copy;
 312         }
 313
 314         if (req->rq_cli_ctx->cc_sec->ps_id != param.secid) {
 315                 CWARN("original secid %d, now has changed to %d, "
 316                       "cancel this negotiation\n", param.secid,
 317                       req->rq_cli_ctx->cc_sec->ps_id);
 318                 param.status = -EINVAL;
 319                 goto out_copy;
 320         }
 321
 322         /* get token */
 323         rc = ctx_init_pack_request(imp, req,
 324                                    param.lustre_svc,
 325                                    param.uid, param.gid,
 326                                    param.send_token_size,
 327                                    param.send_token);
 328         if (rc) {
 329                 param.status = rc;
 330                 goto out_copy;
 331         }
 332
 333         ptlrpc_request_set_replen(req);
 334
 335         rc = ptlrpc_queue_wait(req);
 336         if (rc) {
 337                 /* If any _real_ denial be made, we expect server return
 338                  * -EACCES reply or return success but indicate gss error
 339                  * inside reply messsage. All other errors are treated as
 340                  * timeout, caller might try the negotiation repeatedly,
 341                  * leave recovery decisions to general ptlrpc layer.
 342                  *
 343                  * FIXME maybe some other error code shouldn't be treated
 344                  * as timeout. */
 345                 param.status = rc;
 346                 if (rc != -EACCES)
 347                         param.status = -ETIMEDOUT;
 348                 goto out_copy;
 349         }
 350
 351         LASSERT(req->rq_repdata);
 352         lsize = ctx_init_parse_reply(req->rq_repdata,
 353                                      ptlrpc_rep_need_swab(req),
 354                                      param.reply_buf, param.reply_buf_size);
 355         if (lsize < 0) {
 356                 param.status = (int) lsize;
 357                 goto out_copy;
 358         }
 359
 360         param.status = 0;
 361         param.reply_length = lsize;
 362
 363 out_copy:
 364         if (copy_to_user(buffer, &param, sizeof(param)))
 365                 rc = -EFAULT;
 366         else
 367                 rc = 0;
 368
 369         class_import_put(imp);
 370         ptlrpc_req_finished(req);
 371         RETURN(rc);
 372 }
 373
 374 int gss_do_ctx_fini_rpc(struct gss_cli_ctx *gctx)
 375 {
 376         struct ptlrpc_cli_ctx   *ctx = &gctx->gc_base;
 377         struct obd_import       *imp = ctx->cc_sec->ps_import;
 378         struct ptlrpc_request   *req;
 379         struct ptlrpc_user_desc *pud;
 380         int                      rc;
 381         ENTRY;
 382
 383         LASSERT(atomic_read(&ctx->cc_refcount) > 0);
 384
 385         if (cli_ctx_is_error(ctx) || !cli_ctx_is_uptodate(ctx)) {
 386                 CDEBUG(D_SEC, "ctx %p(%u->%s) not uptodate, "
 387                        "don't send destroy rpc\n", ctx,
 388                        ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 389                 RETURN(0);
 390         }
 391
 392         might_sleep();
 393
 394         CWARN("%s ctx %p idx %#llx (%u->%s)\n",
 395               sec_is_reverse(ctx->cc_sec) ?
 396               "server finishing reverse" : "client finishing forward",
 397               ctx, gss_handle_to_u64(&gctx->gc_handle),
 398               ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 399
 400         gctx->gc_proc = PTLRPC_GSS_PROC_DESTROY;
 401
 402         req = ptlrpc_request_alloc(imp, &RQF_SEC_CTX);
 403         if (req == NULL) {
 404                 CWARN("ctx %p(%u): fail to prepare rpc, destroy locally\n",
 405                       ctx, ctx->cc_vcred.vc_uid);
 406                 GOTO(out, rc = -ENOMEM);
 407         }
 408
 409         rc = ptlrpc_request_bufs_pack(req, LUSTRE_OBD_VERSION, SEC_CTX_FINI,
 410                                       NULL, ctx);
 411         if (rc)
 412                 GOTO(out_ref, rc);
 413
 414         /* fix the user desc */
 415         if (req->rq_pack_udesc) {
 416                 /* we rely the fact that this request is in AUTH mode,
 417                  * and user_desc at offset 2. */
 418                 pud = lustre_msg_buf(req->rq_reqbuf, 2, sizeof(*pud));
 419                 LASSERT(pud);
 420                 pud->pud_uid = pud->pud_fsuid = ctx->cc_vcred.vc_uid;
 421                 pud->pud_gid = pud->pud_fsgid = ctx->cc_vcred.vc_gid;
 422                 pud->pud_cap = 0;
 423                 pud->pud_ngroups = 0;
 424         }
 425
 426         req->rq_phase = RQ_PHASE_RPC;
 427         rc = ptl_send_rpc(req, 1);
 428         if (rc)
 429                 CWARN("ctx %p(%u->%s): rpc error %d, destroy locally\n", ctx,
 430                       ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec), rc);
 431
 432 out_ref:
 433         ptlrpc_req_finished(req);
 434 out:
 435         RETURN(rc);
 436 }
 437
 438 int __init gss_init_cli_upcall(void)
 439 {
 440         return 0;
 441 }
 442
 443 void gss_exit_cli_upcall(void)
 444 {
 445 }