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         /* security payload */
 103         p = lustre_msg_buf(msg, offset, 0);
 104         size = msg->lm_buflens[offset];
 105         LASSERT(p);
 106
 107         /* 1. lustre svc type */
 108         LASSERT(size > 4);
 109         *p++ = cpu_to_le32(lustre_srv);
 110         size -= 4;
 111
 112         /* 2. target uuid */
 113         obj.len = strlen(imp->imp_obd->u.cli.cl_target_uuid.uuid) + 1;
 114         obj.data = imp->imp_obd->u.cli.cl_target_uuid.uuid;
 115         if (rawobj_serialize(&obj, &p, &size))
 116                 LBUG();
 117
 118         /* 3. reverse context handle. actually only needed by root user,
 119          *    but we send it anyway. */
 120         gsec = sec2gsec(req->rq_cli_ctx->cc_sec);
 121         obj.len = sizeof(gsec->gs_rvs_hdl);
 122         obj.data = (__u8 *) &gsec->gs_rvs_hdl;
 123         if (rawobj_serialize(&obj, &p, &size))
 124                 LBUG();
 125
 126         /* 4. now the token */
 127         LASSERT(size >= (sizeof(__u32) + token_size));
 128         *p++ = cpu_to_le32(((__u32) token_size));
 129         if (copy_from_user(p, token, token_size)) {
 130                 CERROR("can't copy token\n");
 131                 return -EFAULT;
 132         }
 133         size -= sizeof(__u32) + cfs_size_round4(token_size);
 134
 135         req->rq_reqdata_len = lustre_shrink_msg(req->rq_reqbuf, offset,
 136                                                 msg->lm_buflens[offset] - size, 0);
 137         return 0;
 138 }
 139
 140 static
 141 int ctx_init_parse_reply(struct lustre_msg *msg, int swabbed,
 142                          char __user *outbuf, long outlen)
 143 {
 144         struct gss_rep_header   *ghdr;
 145         __u32                    obj_len, round_len;
 146         __u32                    status, effective = 0;
 147
 148         if (msg->lm_bufcount != 3) {
 149                 CERROR("unexpected bufcount %u\n", msg->lm_bufcount);
 150                 return -EPROTO;
 151         }
 152
 153         ghdr = (struct gss_rep_header *) gss_swab_header(msg, 0, swabbed);
 154         if (ghdr == NULL) {
 155                 CERROR("unable to extract gss reply header\n");
 156                 return -EPROTO;
 157         }
 158
 159         if (ghdr->gh_version != PTLRPC_GSS_VERSION) {
 160                 CERROR("invalid gss version %u\n", ghdr->gh_version);
 161                 return -EPROTO;
 162         }
 163
 164         if (outlen < (4 + 2) * 4 + cfs_size_round4(ghdr->gh_handle.len) +
 165                      cfs_size_round4(msg->lm_buflens[2])) {
 166                 CERROR("output buffer size %ld too small\n", outlen);
 167                 return -EFAULT;
 168         }
 169
 170         status = 0;
 171         effective = 0;
 172
 173         if (copy_to_user(outbuf, &status, 4))
 174                 return -EFAULT;
 175         outbuf += 4;
 176         if (copy_to_user(outbuf, &ghdr->gh_major, 4))
 177                 return -EFAULT;
 178         outbuf += 4;
 179         if (copy_to_user(outbuf, &ghdr->gh_minor, 4))
 180                 return -EFAULT;
 181         outbuf += 4;
 182         if (copy_to_user(outbuf, &ghdr->gh_seqwin, 4))
 183                 return -EFAULT;
 184         outbuf += 4;
 185         effective += 4 * 4;
 186
 187         /* handle */
 188         obj_len = ghdr->gh_handle.len;
 189         round_len = (obj_len + 3) & ~3;
 190         if (copy_to_user(outbuf, &obj_len, 4))
 191                 return -EFAULT;
 192         outbuf += 4;
 193         if (copy_to_user(outbuf, (char *) ghdr->gh_handle.data, round_len))
 194                 return -EFAULT;
 195         outbuf += round_len;
 196         effective += 4 + round_len;
 197
 198         /* out token */
 199         obj_len = msg->lm_buflens[2];
 200         round_len = (obj_len + 3) & ~3;
 201         if (copy_to_user(outbuf, &obj_len, 4))
 202                 return -EFAULT;
 203         outbuf += 4;
 204         if (copy_to_user(outbuf, lustre_msg_buf(msg, 2, 0), round_len))
 205                 return -EFAULT;
 206         outbuf += round_len;
 207         effective += 4 + round_len;
 208
 209         return effective;
 210 }
 211
 212 /* XXX move to where lgssd could see */
 213 struct lgssd_ioctl_param {
 214         int             version;        /* in   */
 215         int             secid;          /* in   */
 216         char __user    *uuid;           /* in   */
 217         int             lustre_svc;     /* in   */
 218         uid_t           uid;            /* in   */
 219         gid_t           gid;            /* in   */
 220         long            send_token_size;/* in   */
 221         char __user    *send_token;     /* in   */
 222         long            reply_buf_size; /* in   */
 223         char __user    *reply_buf;      /* in   */
 224         long            status;         /* out  */
 225         long            reply_length;   /* out  */
 226 };
 227
 228 int gss_do_ctx_init_rpc(char __user *buffer, unsigned long count)
 229 {
 230         struct obd_import        *imp;
 231         struct ptlrpc_request    *req;
 232         struct lgssd_ioctl_param  param;
 233         struct obd_device        *obd;
 234         char                      obdname[64];
 235         long                      lsize;
 236         int                       rc;
 237
 238         if (count != sizeof(param)) {
 239                 CERROR("ioctl size %lu, expect %lu, please check lgss_keyring "
 240                        "version\n", count, (unsigned long) sizeof(param));
 241                 RETURN(-EINVAL);
 242         }
 243         if (copy_from_user(&param, buffer, sizeof(param))) {
 244                 CERROR("failed copy data from lgssd\n");
 245                 RETURN(-EFAULT);
 246         }
 247
 248         if (param.version != GSSD_INTERFACE_VERSION) {
 249                 CERROR("gssd interface version %d (expect %d)\n",
 250                         param.version, GSSD_INTERFACE_VERSION);
 251                 RETURN(-EINVAL);
 252         }
 253
 254         /* take name */
 255         if (strncpy_from_user(obdname, param.uuid, sizeof(obdname)) <= 0) {
 256                 CERROR("Invalid obdname pointer\n");
 257                 RETURN(-EFAULT);
 258         }
 259
 260         obd = class_name2obd(obdname);
 261         if (!obd) {
 262                 CERROR("no such obd %s\n", obdname);
 263                 RETURN(-EINVAL);
 264         }
 265
 266         if (unlikely(!obd->obd_set_up)) {
 267                 CERROR("obd %s not setup\n", obdname);
 268                 RETURN(-EINVAL);
 269         }
 270
 271         spin_lock(&obd->obd_dev_lock);
 272         if (obd->obd_stopping) {
 273                 CERROR("obd %s has stopped\n", obdname);
 274                 spin_unlock(&obd->obd_dev_lock);
 275                 RETURN(-EINVAL);
 276         }
 277
 278         if (strcmp(obd->obd_type->typ_name, LUSTRE_MDC_NAME) &&
 279             strcmp(obd->obd_type->typ_name, LUSTRE_OSC_NAME) &&
 280             strcmp(obd->obd_type->typ_name, LUSTRE_MGC_NAME) &&
 281             strcmp(obd->obd_type->typ_name, LUSTRE_LWP_NAME) &&
 282             strcmp(obd->obd_type->typ_name, LUSTRE_OSP_NAME)) {
 283                 CERROR("obd %s is not a client device\n", obdname);
 284                 spin_unlock(&obd->obd_dev_lock);
 285                 RETURN(-EINVAL);
 286         }
 287         spin_unlock(&obd->obd_dev_lock);
 288
 289         down_read(&obd->u.cli.cl_sem);
 290         if (obd->u.cli.cl_import == NULL) {
 291                 CERROR("obd %s: import has gone\n", obd->obd_name);
 292                 up_read(&obd->u.cli.cl_sem);
 293                 RETURN(-EINVAL);
 294         }
 295         imp = class_import_get(obd->u.cli.cl_import);
 296         up_read(&obd->u.cli.cl_sem);
 297
 298         if (imp->imp_deactive) {
 299                 CERROR("import has been deactivated\n");
 300                 class_import_put(imp);
 301                 RETURN(-EINVAL);
 302         }
 303
 304         req = ptlrpc_request_alloc_pack(imp, &RQF_SEC_CTX, LUSTRE_OBD_VERSION,
 305                                         SEC_CTX_INIT);
 306         if (req == NULL) {
 307                 param.status = -ENOMEM;
 308                 goto out_copy;
 309         }
 310
 311         if (req->rq_cli_ctx->cc_sec->ps_id != param.secid) {
 312                 CWARN("original secid %d, now has changed to %d, "
 313                       "cancel this negotiation\n", param.secid,
 314                       req->rq_cli_ctx->cc_sec->ps_id);
 315                 param.status = -EINVAL;
 316                 goto out_copy;
 317         }
 318
 319         /* get token */
 320         rc = ctx_init_pack_request(imp, req,
 321                                    param.lustre_svc,
 322                                    param.uid, param.gid,
 323                                    param.send_token_size,
 324                                    param.send_token);
 325         if (rc) {
 326                 param.status = rc;
 327                 goto out_copy;
 328         }
 329
 330         ptlrpc_request_set_replen(req);
 331
 332         rc = ptlrpc_queue_wait(req);
 333         if (rc) {
 334                 /* If any _real_ denial be made, we expect server return
 335                  * -EACCES reply or return success but indicate gss error
 336                  * inside reply messsage. All other errors are treated as
 337                  * timeout, caller might try the negotiation repeatedly,
 338                  * leave recovery decisions to general ptlrpc layer.
 339                  *
 340                  * FIXME maybe some other error code shouldn't be treated
 341                  * as timeout. */
 342                 param.status = rc;
 343                 if (rc != -EACCES)
 344                         param.status = -ETIMEDOUT;
 345                 goto out_copy;
 346         }
 347
 348         LASSERT(req->rq_repdata);
 349         lsize = ctx_init_parse_reply(req->rq_repdata,
 350                                      ptlrpc_rep_need_swab(req),
 351                                      param.reply_buf, param.reply_buf_size);
 352         if (lsize < 0) {
 353                 param.status = (int) lsize;
 354                 goto out_copy;
 355         }
 356
 357         param.status = 0;
 358         param.reply_length = lsize;
 359
 360 out_copy:
 361         if (copy_to_user(buffer, &param, sizeof(param)))
 362                 rc = -EFAULT;
 363         else
 364                 rc = 0;
 365
 366         class_import_put(imp);
 367         ptlrpc_req_finished(req);
 368         RETURN(rc);
 369 }
 370
 371 int gss_do_ctx_fini_rpc(struct gss_cli_ctx *gctx)
 372 {
 373         struct ptlrpc_cli_ctx   *ctx = &gctx->gc_base;
 374         struct obd_import       *imp = ctx->cc_sec->ps_import;
 375         struct ptlrpc_request   *req;
 376         struct ptlrpc_user_desc *pud;
 377         int                      rc;
 378         ENTRY;
 379
 380         LASSERT(atomic_read(&ctx->cc_refcount) > 0);
 381
 382         if (cli_ctx_is_error(ctx) || !cli_ctx_is_uptodate(ctx)) {
 383                 CDEBUG(D_SEC, "ctx %p(%u->%s) not uptodate, "
 384                        "don't send destroy rpc\n", ctx,
 385                        ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 386                 RETURN(0);
 387         }
 388
 389         might_sleep();
 390
 391         CWARN("%s ctx %p idx %#llx (%u->%s)\n",
 392               sec_is_reverse(ctx->cc_sec) ?
 393               "server finishing reverse" : "client finishing forward",
 394               ctx, gss_handle_to_u64(&gctx->gc_handle),
 395               ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec));
 396
 397         gctx->gc_proc = PTLRPC_GSS_PROC_DESTROY;
 398
 399         req = ptlrpc_request_alloc(imp, &RQF_SEC_CTX);
 400         if (req == NULL) {
 401                 CWARN("ctx %p(%u): fail to prepare rpc, destroy locally\n",
 402                       ctx, ctx->cc_vcred.vc_uid);
 403                 GOTO(out, rc = -ENOMEM);
 404         }
 405
 406         rc = ptlrpc_request_bufs_pack(req, LUSTRE_OBD_VERSION, SEC_CTX_FINI,
 407                                       NULL, ctx);
 408         if (rc)
 409                 GOTO(out_ref, rc);
 410
 411         /* fix the user desc */
 412         if (req->rq_pack_udesc) {
 413                 /* we rely the fact that this request is in AUTH mode,
 414                  * and user_desc at offset 2. */
 415                 pud = lustre_msg_buf(req->rq_reqbuf, 2, sizeof(*pud));
 416                 LASSERT(pud);
 417                 pud->pud_uid = pud->pud_fsuid = ctx->cc_vcred.vc_uid;
 418                 pud->pud_gid = pud->pud_fsgid = ctx->cc_vcred.vc_gid;
 419                 pud->pud_cap = 0;
 420                 pud->pud_ngroups = 0;
 421         }
 422
 423         req->rq_phase = RQ_PHASE_RPC;
 424         rc = ptl_send_rpc(req, 1);
 425         if (rc)
 426                 CWARN("ctx %p(%u->%s): rpc error %d, destroy locally\n", ctx,
 427                       ctx->cc_vcred.vc_uid, sec2target_str(ctx->cc_sec), rc);
 428
 429 out_ref:
 430         ptlrpc_req_finished(req);
 431 out:
 432         RETURN(rc);
 433 }
 434
 435 int __init gss_init_cli_upcall(void)
 436 {
 437         return 0;
 438 }
 439
 440 void gss_exit_cli_upcall(void)
 441 {
 442 }