net/sunrpc/auth_gss/gss_rpc_upcall.c

   1 /*
   2  *  linux/net/sunrpc/gss_rpc_upcall.c
   3  *
   4  *  Copyright (C) 2012 Simo Sorce <simo@redhat.com>
   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 as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 #include <linux/types.h>
  22 #include <linux/un.h>
  23
  24 #include <linux/sunrpc/svcauth.h>
  25 #include "gss_rpc_upcall.h"
  26
  27 #define GSSPROXY_SOCK_PATHNAME  "/var/run/gssproxy.sock"
  28
  29 #define GSSPROXY_PROGRAM        (400112u)
  30 #define GSSPROXY_VERS_1         (1u)
  31
  32 /*
  33  * Encoding/Decoding functions
  34  */
  35
  36 enum {
  37         GSSX_NULL = 0,  /* Unused */
  38         GSSX_INDICATE_MECHS = 1,
  39         GSSX_GET_CALL_CONTEXT = 2,
  40         GSSX_IMPORT_AND_CANON_NAME = 3,
  41         GSSX_EXPORT_CRED = 4,
  42         GSSX_IMPORT_CRED = 5,
  43         GSSX_ACQUIRE_CRED = 6,
  44         GSSX_STORE_CRED = 7,
  45         GSSX_INIT_SEC_CONTEXT = 8,
  46         GSSX_ACCEPT_SEC_CONTEXT = 9,
  47         GSSX_RELEASE_HANDLE = 10,
  48         GSSX_GET_MIC = 11,
  49         GSSX_VERIFY = 12,
  50         GSSX_WRAP = 13,
  51         GSSX_UNWRAP = 14,
  52         GSSX_WRAP_SIZE_LIMIT = 15,
  53 };
  54
  55 #define PROC(proc, name)                                \
  56 [GSSX_##proc] = {                                       \
  57         .p_proc   = GSSX_##proc,                        \
  58         .p_encode = (kxdreproc_t)gssx_enc_##name,       \
  59         .p_decode = (kxdrdproc_t)gssx_dec_##name,       \
  60         .p_arglen = GSSX_ARG_##name##_sz,               \
  61         .p_replen = GSSX_RES_##name##_sz,               \
  62         .p_statidx = GSSX_##proc,                       \
  63         .p_name   = #proc,                              \
  64 }
  65
  66 struct rpc_procinfo gssp_procedures[] = {
  67         PROC(INDICATE_MECHS, indicate_mechs),
  68         PROC(GET_CALL_CONTEXT, get_call_context),
  69         PROC(IMPORT_AND_CANON_NAME, import_and_canon_name),
  70         PROC(EXPORT_CRED, export_cred),
  71         PROC(IMPORT_CRED, import_cred),
  72         PROC(ACQUIRE_CRED, acquire_cred),
  73         PROC(STORE_CRED, store_cred),
  74         PROC(INIT_SEC_CONTEXT, init_sec_context),
  75         PROC(ACCEPT_SEC_CONTEXT, accept_sec_context),
  76         PROC(RELEASE_HANDLE, release_handle),
  77         PROC(GET_MIC, get_mic),
  78         PROC(VERIFY, verify),
  79         PROC(WRAP, wrap),
  80         PROC(UNWRAP, unwrap),
  81         PROC(WRAP_SIZE_LIMIT, wrap_size_limit),
  82 };
  83
  84
  85
  86 /*
  87  * Common transport functions
  88  */
  89
  90 static const struct rpc_program gssp_program;
  91
  92 static int gssp_rpc_create(struct net *net, struct rpc_clnt **_clnt)
  93 {
  94         static const struct sockaddr_un gssp_localaddr = {
  95                 .sun_family             = AF_LOCAL,
  96                 .sun_path               = GSSPROXY_SOCK_PATHNAME,
  97         };
  98         struct rpc_create_args args = {
  99                 .net            = net,
 100                 .protocol       = XPRT_TRANSPORT_LOCAL,
 101                 .address        = (struct sockaddr *)&gssp_localaddr,
 102                 .addrsize       = sizeof(gssp_localaddr),
 103                 .servername     = "localhost",
 104                 .program        = &gssp_program,
 105                 .version        = GSSPROXY_VERS_1,
 106                 .authflavor     = RPC_AUTH_NULL,
 107                 /*
 108                  * Note we want connection to be done in the caller's
 109                  * filesystem namespace.  We therefore turn off the idle
 110                  * timeout, which would result in reconnections being
 111                  * done without the correct namespace:
 112                  */
 113                 .flags          = RPC_CLNT_CREATE_NOPING |
 114                                   RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
 115         };
 116         struct rpc_clnt *clnt;
 117         int result = 0;
 118
 119         clnt = rpc_create(&args);
 120         if (IS_ERR(clnt)) {
 121                 dprintk("RPC:       failed to create AF_LOCAL gssproxy "
 122                                 "client (errno %ld).\n", PTR_ERR(clnt));
 123                 result = -PTR_ERR(clnt);
 124                 *_clnt = NULL;
 125                 goto out;
 126         }
 127
 128         dprintk("RPC:       created new gssp local client (gssp_local_clnt: "
 129                         "%p)\n", clnt);
 130         *_clnt = clnt;
 131
 132 out:
 133         return result;
 134 }
 135
 136 void init_gssp_clnt(struct sunrpc_net *sn)
 137 {
 138         mutex_init(&sn->gssp_lock);
 139         sn->gssp_clnt = NULL;
 140         init_waitqueue_head(&sn->gssp_wq);
 141 }
 142
 143 int set_gssp_clnt(struct net *net)
 144 {
 145         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 146         struct rpc_clnt *clnt;
 147         int ret;
 148
 149         mutex_lock(&sn->gssp_lock);
 150         ret = gssp_rpc_create(net, &clnt);
 151         if (!ret) {
 152                 if (sn->gssp_clnt)
 153                         rpc_shutdown_client(sn->gssp_clnt);
 154                 sn->gssp_clnt = clnt;
 155         }
 156         mutex_unlock(&sn->gssp_lock);
 157         wake_up(&sn->gssp_wq);
 158         return ret;
 159 }
 160
 161 void clear_gssp_clnt(struct sunrpc_net *sn)
 162 {
 163         mutex_lock(&sn->gssp_lock);
 164         if (sn->gssp_clnt) {
 165                 rpc_shutdown_client(sn->gssp_clnt);
 166                 sn->gssp_clnt = NULL;
 167         }
 168         mutex_unlock(&sn->gssp_lock);
 169 }
 170
 171 static struct rpc_clnt *get_gssp_clnt(struct sunrpc_net *sn)
 172 {
 173         struct rpc_clnt *clnt;
 174
 175         mutex_lock(&sn->gssp_lock);
 176         clnt = sn->gssp_clnt;
 177         if (clnt)
 178                 atomic_inc(&clnt->cl_count);
 179         mutex_unlock(&sn->gssp_lock);
 180         return clnt;
 181 }
 182
 183 static int gssp_call(struct net *net, struct rpc_message *msg)
 184 {
 185         struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
 186         struct rpc_clnt *clnt;
 187         int status;
 188
 189         clnt = get_gssp_clnt(sn);
 190         if (!clnt)
 191                 return -EIO;
 192         status = rpc_call_sync(clnt, msg, 0);
 193         if (status < 0) {
 194                 dprintk("gssp: rpc_call returned error %d\n", -status);
 195                 switch (status) {
 196                 case -EPROTONOSUPPORT:
 197                         status = -EINVAL;
 198                         break;
 199                 case -ECONNREFUSED:
 200                 case -ETIMEDOUT:
 201                 case -ENOTCONN:
 202                         status = -EAGAIN;
 203                         break;
 204                 case -ERESTARTSYS:
 205                         if (signalled ())
 206                                 status = -EINTR;
 207                         break;
 208                 default:
 209                         break;
 210                 }
 211         }
 212         rpc_release_client(clnt);
 213         return status;
 214 }
 215
 216
 217 /*
 218  * Public functions
 219  */
 220
 221 /* numbers somewhat arbitrary but large enough for current needs */
 222 #define GSSX_MAX_OUT_HANDLE     128
 223 #define GSSX_MAX_MECH_OID       16
 224 #define GSSX_MAX_SRC_PRINC      256
 225 #define GSSX_KMEMBUF (GSSX_max_output_handle_sz + \
 226                         GSSX_max_oid_sz + \
 227                         GSSX_max_princ_sz + \
 228                         sizeof(struct svc_cred))
 229
 230 int gssp_accept_sec_context_upcall(struct net *net,
 231                                 struct gssp_upcall_data *data)
 232 {
 233         struct gssx_ctx ctxh = {
 234                 .state = data->in_handle
 235         };
 236         struct gssx_arg_accept_sec_context arg = {
 237                 .input_token = data->in_token,
 238         };
 239         struct gssx_ctx rctxh = {
 240                 /*
 241                  * pass in the max length we expect for each of these
 242                  * buffers but let the xdr code kmalloc them:
 243                  */
 244                 .exported_context_token.len = GSSX_max_output_handle_sz,
 245                 .mech.len = GSSX_max_oid_sz,
 246                 .src_name.display_name.len = GSSX_max_princ_sz
 247         };
 248         struct gssx_res_accept_sec_context res = {
 249                 .context_handle = &rctxh,
 250                 .output_token = &data->out_token
 251         };
 252         struct rpc_message msg = {
 253                 .rpc_proc = &gssp_procedures[GSSX_ACCEPT_SEC_CONTEXT],
 254                 .rpc_argp = &arg,
 255                 .rpc_resp = &res,
 256                 .rpc_cred = NULL, /* FIXME ? */
 257         };
 258         struct xdr_netobj client_name = { 0 , NULL };
 259         int ret;
 260
 261         if (data->in_handle.len != 0)
 262                 arg.context_handle = &ctxh;
 263         res.output_token->len = GSSX_max_output_token_sz;
 264
 265         /* use nfs/ for targ_name ? */
 266
 267         ret = gssp_call(net, &msg);
 268
 269         /* we need to fetch all data even in case of error so
 270          * that we can free special strctures is they have been allocated */
 271         data->major_status = res.status.major_status;
 272         data->minor_status = res.status.minor_status;
 273         if (res.context_handle) {
 274                 data->out_handle = rctxh.exported_context_token;
 275                 data->mech_oid = rctxh.mech;
 276                 client_name = rctxh.src_name.display_name;
 277         }
 278
 279         if (res.options.count == 1) {
 280                 gssx_buffer *value = &res.options.data[0].value;
 281                 /* Currently we only decode CREDS_VALUE, if we add
 282                  * anything else we'll have to loop and match on the
 283                  * option name */
 284                 if (value->len == 1) {
 285                         /* steal group info from struct svc_cred */
 286                         data->creds = *(struct svc_cred *)value->data;
 287                         data->found_creds = 1;
 288                 }
 289                 /* whether we use it or not, free data */
 290                 kfree(value->data);
 291         }
 292
 293         if (res.options.count != 0) {
 294                 kfree(res.options.data);
 295         }
 296
 297         /* convert to GSS_NT_HOSTBASED_SERVICE form and set into creds */
 298         if (data->found_creds && client_name.data != NULL) {
 299                 char *c;
 300
 301                 data->creds.cr_principal = kstrndup(client_name.data,
 302                                                 client_name.len, GFP_KERNEL);
 303                 if (data->creds.cr_principal) {
 304                         /* terminate and remove realm part */
 305                         c = strchr(data->creds.cr_principal, '@');
 306                         if (c) {
 307                                 *c = '\0';
 308
 309                                 /* change service-hostname delimiter */
 310                                 c = strchr(data->creds.cr_principal, '/');
 311                                 if (c) *c = '@';
 312                         }
 313                         if (!c) {
 314                                 /* not a service principal */
 315                                 kfree(data->creds.cr_principal);
 316                                 data->creds.cr_principal = NULL;
 317                         }
 318                 }
 319         }
 320         kfree(client_name.data);
 321
 322         return ret;
 323 }
 324
 325 void gssp_free_upcall_data(struct gssp_upcall_data *data)
 326 {
 327         kfree(data->in_handle.data);
 328         kfree(data->out_handle.data);
 329         kfree(data->out_token.data);
 330         kfree(data->mech_oid.data);
 331         free_svc_cred(&data->creds);
 332 }
 333
 334 /*
 335  * Initialization stuff
 336  */
 337
 338 static const struct rpc_version gssp_version1 = {
 339         .number         = GSSPROXY_VERS_1,
 340         .nrprocs        = ARRAY_SIZE(gssp_procedures),
 341         .procs          = gssp_procedures,
 342 };
 343
 344 static const struct rpc_version *gssp_version[] = {
 345         NULL,
 346         &gssp_version1,
 347 };
 348
 349 static struct rpc_stat gssp_stats;
 350
 351 static const struct rpc_program gssp_program = {
 352         .name           = "gssproxy",
 353         .number         = GSSPROXY_PROGRAM,
 354         .nrvers         = ARRAY_SIZE(gssp_version),
 355         .version        = gssp_version,
 356         .stats          = &gssp_stats,
 357 };