lustre/utils/gss/gss_util.c

   1 /*
   2  *  Adapted in part from MIT Kerberos 5-1.2.1 slave/kprop.c and from
   3  *  http://docs.sun.com/?p=/doc/816-1331/6m7oo9sms&a=view
   4  *
   5  *  Copyright (c) 2002 The Regents of the University of Michigan.
   6  *  All rights reserved.
   7  *
   8  *  Andy Adamson <andros@umich.edu>
   9  *  J. Bruce Fields <bfields@umich.edu>
  10  *  Marius Aamodt Eriksen <marius@umich.edu>
  11  */
  12
  13 /*
  14  * slave/kprop.c
  15  *
  16  * Copyright 1990,1991 by the Massachusetts Institute of Technology.
  17  * All Rights Reserved.
  18  *
  19  * Export of this software from the United States of America may
  20  *   require a specific license from the United States Government.
  21  *   It is the responsibility of any person or organization contemplating
  22  *   export to obtain such a license before exporting.
  23  *
  24  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  25  * distribute this software and its documentation for any purpose and
  26  * without fee is hereby granted, provided that the above copyright
  27  * notice appear in all copies and that both that copyright notice and
  28  * this permission notice appear in supporting documentation, and that
  29  * the name of M.I.T. not be used in advertising or publicity pertaining
  30  * to distribution of the software without specific, written prior
  31  * permission.  Furthermore if you modify this software you must label
  32  * your software as modified software and not distribute it in such a
  33  * fashion that it might be confused with the original M.I.T. software.
  34  * M.I.T. makes no representations about the suitability of
  35  * this software for any purpose.  It is provided "as is" without express
  36  * or implied warranty.
  37  */
  38
  39 /*
  40  * Copyright 1994 by OpenVision Technologies, Inc.
  41  *
  42  * Permission to use, copy, modify, distribute, and sell this software
  43  * and its documentation for any purpose is hereby granted without fee,
  44  * provided that the above copyright notice appears in all copies and
  45  * that both that copyright notice and this permission notice appear in
  46  * supporting documentation, and that the name of OpenVision not be used
  47  * in advertising or publicity pertaining to distribution of the software
  48  * without specific, written prior permission. OpenVision makes no
  49  * representations about the suitability of this software for any
  50  * purpose.  It is provided "as is" without express or implied warranty.
  51  *
  52  * OPENVISION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  53  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  54  * EVENT SHALL OPENVISION BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  55  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  56  * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  57  * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  58  * PERFORMANCE OF THIS SOFTWARE.
  59  */
  60 #include "config.h"
  61 #include <errno.h>
  62 #include <stdio.h>
  63 #include <ctype.h>
  64 #include <string.h>
  65 #include <sys/param.h>
  66 #include <gssapi/gssapi.h>
  67 #if defined(HAVE_KRB5) && !defined(GSS_C_NT_HOSTBASED_SERVICE)
  68 #include <gssapi/gssapi_generic.h>
  69 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  70 #endif
  71 #include "gss_util.h"
  72 #include "err_util.h"
  73 #include "gssd.h"
  74 #ifdef HAVE_UNISTD_H
  75 # include <unistd.h>
  76 #endif
  77 #include <stdlib.h>
  78 #ifdef HAVE_COM_ERR_H
  79 # include <com_err.h>
  80 #endif
  81 #include "lsupport.h"
  82
  83 /* Global gssd_credentials handle */
  84 gss_cred_id_t  gssd_cred_mgs;
  85 gss_cred_id_t  gssd_cred_mds;
  86 gss_cred_id_t  gssd_cred_oss;
  87 int            gssd_cred_mgs_valid = 0;
  88 int            gssd_cred_mds_valid = 0;
  89 int            gssd_cred_oss_valid = 0;
  90
  91 char *mgs_local_realm = NULL;
  92 char *mds_local_realm = NULL;
  93 char *oss_local_realm = NULL;
  94
  95 gss_OID g_mechOid = GSS_C_NULL_OID;;
  96
  97 #if 0
  98 static void
  99 display_status_1(char *m, u_int32_t code, int type, const gss_OID mech)
 100 {
 101         u_int32_t maj_stat, min_stat;
 102         gss_buffer_desc msg = GSS_C_EMPTY_BUFFER;
 103         u_int32_t msg_ctx = 0;
 104         char *typestr;
 105
 106         switch (type) {
 107         case GSS_C_GSS_CODE:
 108                 typestr = "GSS";
 109                 break;
 110         case GSS_C_MECH_CODE:
 111                 typestr = "mechanism";
 112                 break;
 113         default:
 114                 return;
 115                 /* NOTREACHED */
 116         }
 117
 118         for (;;) {
 119                 maj_stat = gss_display_status(&min_stat, code,
 120                     type, mech, &msg_ctx, &msg);
 121                 if (maj_stat != GSS_S_COMPLETE) {
 122                         printerr(0, "ERROR: in call to "
 123                                 "gss_display_status called from %s\n", m);
 124                         break;
 125                 } else {
 126                         printerr(0, "ERROR: GSS-API: (%s) error in %s(): %s\n",
 127                             typestr, m, (char *)msg.value);
 128                 }
 129
 130                 if (msg.length != 0)
 131                         (void) gss_release_buffer(&min_stat, &msg);
 132
 133                 if (msg_ctx == 0)
 134                         break;
 135         }
 136 }
 137 #endif
 138
 139 static void
 140 display_status_2(char *m, u_int32_t major, u_int32_t minor, const gss_OID mech)
 141 {
 142         u_int32_t maj_stat1, min_stat1;
 143         u_int32_t maj_stat2, min_stat2;
 144         gss_buffer_desc maj_gss_buf = GSS_C_EMPTY_BUFFER;
 145         gss_buffer_desc min_gss_buf = GSS_C_EMPTY_BUFFER;
 146         char maj_buf[30], min_buf[30];
 147         char *maj, *min;
 148         u_int32_t msg_ctx = 0;
 149
 150         /* Get major status message */
 151         maj_stat1 = gss_display_status(&min_stat1, major,
 152                 GSS_C_GSS_CODE, mech, &msg_ctx, &maj_gss_buf);
 153
 154         if (maj_stat1 != GSS_S_COMPLETE) {
 155                 snprintf(maj_buf, sizeof(maj_buf), "(0x%08x)", major);
 156                 maj = &maj_buf[0];
 157         } else {
 158                 maj = maj_gss_buf.value;
 159         }
 160
 161         /* Get minor status message */
 162         maj_stat2 = gss_display_status(&min_stat2, minor,
 163                 GSS_C_MECH_CODE, mech, &msg_ctx, &min_gss_buf);
 164
 165         if (maj_stat2 != GSS_S_COMPLETE) {
 166                 snprintf(min_buf, sizeof(min_buf), "(0x%08x)", minor);
 167                 min = &min_buf[0];
 168         } else {
 169                 min = min_gss_buf.value;
 170         }
 171
 172         printerr(0, "ERROR: GSS-API: error in %s(): %s - %s\n",
 173                  m, maj, min);
 174
 175         if (maj_gss_buf.length != 0)
 176                 (void) gss_release_buffer(&min_stat1, &maj_gss_buf);
 177         if (min_gss_buf.length != 0)
 178                 (void) gss_release_buffer(&min_stat2, &min_gss_buf);
 179 }
 180
 181 void
 182 pgsserr(char *msg, u_int32_t maj_stat, u_int32_t min_stat, const gss_OID mech)
 183 {
 184         display_status_2(msg, maj_stat, min_stat, mech);
 185 }
 186
 187 static
 188 int extract_realm_name(gss_buffer_desc *name, char **realm)
 189 {
 190         char *sname, *c;
 191         int   rc = 0;
 192
 193         sname = malloc(name->length + 1);
 194         if (!sname) {
 195                 printerr(0, "out of memory\n");
 196                 return -ENOMEM;
 197         }
 198
 199         memcpy(sname, name->value, name->length);
 200         sname[name->length] = '\0';
 201         printerr(1, "service principal: %s\n", sname);
 202
 203         c = strchr(sname, '@');
 204         if (!c) {
 205                 printerr(2, "no realm found in principal, use default\n");
 206                 *realm = strdup(this_realm);
 207                 if (!*realm) {
 208                         printerr(0, "failed to duplicate default realm\n");
 209                         rc = -ENOMEM;
 210                 }
 211         } else {
 212                 c++;
 213                 *realm = strdup(c);
 214                 if (!*realm) {
 215                         printerr(0, "failed to duplicated realm\n");
 216                         rc = -ENOMEM;
 217                 }
 218         }
 219         free(sname);
 220
 221         return rc;
 222 }
 223
 224 static
 225 int gssd_acquire_cred(char *server_name, gss_cred_id_t *cred,
 226                       char **local_realm, int *valid)
 227 {
 228         gss_buffer_desc name;
 229         gss_name_t target_name;
 230         u_int32_t maj_stat, min_stat;
 231         u_int32_t ignore_maj_stat, ignore_min_stat;
 232         gss_OID name_type;
 233         gss_buffer_desc pbuf;
 234
 235         *valid = 0;
 236
 237         name.value = (void *)server_name;
 238         name.length = strlen(server_name);
 239
 240         maj_stat = gss_import_name(&min_stat, &name,
 241                         (const gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
 242                         &target_name);
 243
 244         if (maj_stat != GSS_S_COMPLETE) {
 245                 pgsserr("gss_import_name", maj_stat, min_stat, g_mechOid);
 246                 return -1;
 247         }
 248
 249         maj_stat = gss_display_name(&min_stat, target_name, &name, &name_type);
 250         if (maj_stat != GSS_S_COMPLETE) {
 251                 pgsserr(0, maj_stat, min_stat, g_mechOid);
 252                 return -1;
 253         }
 254         if (extract_realm_name(&name, local_realm))
 255                 return -1;
 256
 257         maj_stat = gss_acquire_cred(&min_stat, target_name, 0,
 258                         GSS_C_NULL_OID_SET, GSS_C_ACCEPT,
 259                         cred, NULL, NULL);
 260
 261         if (maj_stat != GSS_S_COMPLETE) {
 262                 pgsserr("gss_acquire_cred", maj_stat, min_stat, g_mechOid);
 263                 ignore_maj_stat = gss_display_name(&ignore_min_stat,
 264                                 target_name, &pbuf, NULL);
 265                 if (ignore_maj_stat == GSS_S_COMPLETE) {
 266                         printerr(0, "Unable to obtain credentials for '%.*s'\n",
 267                                  pbuf.length, pbuf.value);
 268                         ignore_maj_stat = gss_release_buffer(&ignore_min_stat,
 269                                                              &pbuf);
 270                 }
 271         } else
 272                 *valid = 1;
 273
 274         ignore_maj_stat = gss_release_name(&ignore_min_stat, &target_name);
 275
 276         if (maj_stat != GSS_S_COMPLETE)
 277                 return -1;
 278         return 0;
 279 }
 280
 281 int gssd_prepare_creds(int must_srv_mgs, int must_srv_mds, int must_srv_oss)
 282 {
 283         if (gssd_acquire_cred(GSSD_SERVICE_MGS, &gssd_cred_mgs,
 284                               &mgs_local_realm, &gssd_cred_mgs_valid)) {
 285                 if (must_srv_mgs)
 286                         return -1;
 287         }
 288
 289         if (gssd_acquire_cred(GSSD_SERVICE_MDS, &gssd_cred_mds,
 290                               &mds_local_realm, &gssd_cred_mds_valid)) {
 291                 if (must_srv_mds)
 292                         return -1;
 293         }
 294
 295         if (gssd_acquire_cred(GSSD_SERVICE_OSS, &gssd_cred_oss,
 296                               &oss_local_realm, &gssd_cred_oss_valid)) {
 297                 if (must_srv_oss)
 298                         return -1;
 299         }
 300
 301         if (!gssd_cred_mgs_valid &&
 302             !gssd_cred_mds_valid &&
 303             !gssd_cred_oss_valid) {
 304                 printerr(0, "can't obtain any service creds, exit\n");
 305                 return -1;
 306         }
 307
 308         if (gssd_cred_mgs_valid)
 309                 printerr(0, "Ready to serve Lustre MGS in realm %s\n",
 310                          mgs_local_realm ? mgs_local_realm : "N/A");
 311         if (gssd_cred_mds_valid)
 312                 printerr(0, "Ready to serve Lustre MDS in realm %s\n",
 313                          mds_local_realm ? mds_local_realm : "N/A");
 314         if (gssd_cred_oss_valid)
 315                 printerr(0, "Ready to serve Lustre OSS in realm %s\n",
 316                          oss_local_realm ? oss_local_realm : "N/A");
 317
 318         return 0;
 319 }
 320
 321 gss_cred_id_t gssd_select_svc_cred(int lustre_svc)
 322 {
 323         switch (lustre_svc) {
 324         case LUSTRE_GSS_SVC_MGS:
 325                 if (!gssd_cred_mgs_valid) {
 326                         printerr(0, "ERROR: service cred for mgs not ready\n");
 327                         return NULL;
 328                 }
 329                 return gssd_cred_mgs;
 330         case LUSTRE_GSS_SVC_MDS:
 331                 if (!gssd_cred_mds_valid) {
 332                         printerr(0, "ERROR: service cred for mds not ready\n");
 333                         return NULL;
 334                 }
 335                 printerr(2, "select mds service cred\n");
 336                 return gssd_cred_mds;
 337         case LUSTRE_GSS_SVC_OSS:
 338                 if (!gssd_cred_oss_valid) {
 339                         printerr(0, "ERROR: service cred for oss not ready\n");
 340                         return NULL;
 341                 }
 342                 printerr(2, "select oss service cred\n");
 343                 return gssd_cred_oss;
 344         default:
 345                 printerr(0, "ERROR: invalid lustre svc id %d\n", lustre_svc);
 346         }
 347
 348         return NULL;
 349 }
 350
 351 int gssd_check_mechs(void)
 352 {
 353         u_int32_t maj_stat, min_stat;
 354         gss_OID_set supported_mechs = GSS_C_NO_OID_SET;
 355         int retval = -1;
 356
 357         maj_stat = gss_indicate_mechs(&min_stat, &supported_mechs);
 358         if (maj_stat != GSS_S_COMPLETE) {
 359                 printerr(0, "Unable to obtain list of supported mechanisms. "
 360                          "Check that gss library is properly configured.\n");
 361                 goto out;
 362         }
 363         if (supported_mechs == GSS_C_NO_OID_SET ||
 364             supported_mechs->count == 0) {
 365                 printerr(0, "Unable to obtain list of supported mechanisms. "
 366                          "Check that gss library is properly configured.\n");
 367                 goto out;
 368         }
 369         maj_stat = gss_release_oid_set(&min_stat, &supported_mechs);
 370         retval = 0;
 371 out:
 372         return retval;
 373 }
 374
 375 /*********************************
 376  * FIXME should be in krb5_util.c
 377  *********************************/
 378
 379 #include "krb5_util.h"
 380
 381 /* realm of this node */
 382 char *this_realm = NULL;
 383
 384 int gssd_get_local_realm(void)
 385 {
 386         krb5_context context = NULL;
 387         krb5_error_code code;
 388         int retval = -1;
 389
 390         if (this_realm != NULL)
 391                 return 0;
 392
 393         code = krb5_init_context(&context);
 394         if (code) {
 395                 printerr(0, "ERROR: get default realm: init ctx: %s\n",
 396                          error_message(code));
 397                 goto out;
 398         }
 399
 400         code = krb5_get_default_realm(context, &this_realm);
 401         if (code) {
 402                 printerr(0, "ERROR: get default realm: %s\n",
 403                          error_message(code));
 404                 goto out;
 405         }
 406         retval = 0;
 407
 408         printerr(1, "Local realm: %s\n", this_realm);
 409 out:
 410         krb5_free_context(context);
 411         return retval;
 412 }
 413