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 <krb5.h>
  66 #include <sys/param.h>
  67 #include <sys/types.h>
  68 #include <gssapi/gssapi.h>
  69 #if defined(HAVE_KRB5) && !defined(GSS_C_NT_HOSTBASED_SERVICE)
  70 #include <gssapi/gssapi_generic.h>
  71 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  72 #endif
  73 #include "gss_util.h"
  74 #include "err_util.h"
  75 #ifdef HAVE_UNISTD_H
  76 # include <unistd.h>
  77 #endif
  78 #include <stdlib.h>
  79 #ifdef HAVE_COM_ERR_H
  80 # include <com_err.h>
  81 #endif
  82 #include "lsupport.h"
  83 #include "svcgssd.h"
  84
  85 #define GSSD_SERVICE_MGS                        "lustre_mgs"
  86 #define GSSD_SERVICE_MDS                        "lustre_mds"
  87 #define GSSD_SERVICE_OSS                        "lustre_oss"
  88
  89 /* Global gssd_credentials handle */
  90 gss_cred_id_t  gssd_cred_mgs;
  91 gss_cred_id_t  gssd_cred_mds;
  92 gss_cred_id_t  gssd_cred_oss;
  93 int            gssd_cred_mgs_valid = 0;
  94 int            gssd_cred_mds_valid = 0;
  95 int            gssd_cred_oss_valid = 0;
  96
  97 char *mgs_local_realm = NULL;
  98 char *mds_local_realm = NULL;
  99 char *oss_local_realm = NULL;
 100
 101 gss_OID g_mechOid = GSS_C_NULL_OID;;
 102
 103 #if 0
 104 static void
 105 display_status_1(char *m, u_int32_t code, int type, const gss_OID mech)
 106 {
 107         u_int32_t maj_stat, min_stat;
 108         gss_buffer_desc msg = GSS_C_EMPTY_BUFFER;
 109         u_int32_t msg_ctx = 0;
 110         char *typestr;
 111
 112         switch (type) {
 113         case GSS_C_GSS_CODE:
 114                 typestr = "GSS";
 115                 break;
 116         case GSS_C_MECH_CODE:
 117                 typestr = "mechanism";
 118                 break;
 119         default:
 120                 return;
 121                 /* NOTREACHED */
 122         }
 123
 124         for (;;) {
 125                 maj_stat = gss_display_status(&min_stat, code,
 126                     type, mech, &msg_ctx, &msg);
 127                 if (maj_stat != GSS_S_COMPLETE) {
 128                         printerr(0, "ERROR: in call to "
 129                                 "gss_display_status called from %s\n", m);
 130                         break;
 131                 } else {
 132                         printerr(0, "ERROR: GSS-API: (%s) error in %s(): %s\n",
 133                             typestr, m, (char *)msg.value);
 134                 }
 135
 136                 if (msg.length != 0)
 137                         (void) gss_release_buffer(&min_stat, &msg);
 138
 139                 if (msg_ctx == 0)
 140                         break;
 141         }
 142 }
 143 #endif
 144
 145 static void
 146 display_status_2(char *m, u_int32_t major, u_int32_t minor, const gss_OID mech)
 147 {
 148         u_int32_t maj_stat1, min_stat1;
 149         u_int32_t maj_stat2, min_stat2;
 150         gss_buffer_desc maj_gss_buf = GSS_C_EMPTY_BUFFER;
 151         gss_buffer_desc min_gss_buf = GSS_C_EMPTY_BUFFER;
 152         char maj_buf[30], min_buf[30];
 153         char *maj, *min;
 154         u_int32_t msg_ctx = 0;
 155
 156         /* Get major status message */
 157         maj_stat1 = gss_display_status(&min_stat1, major,
 158                 GSS_C_GSS_CODE, mech, &msg_ctx, &maj_gss_buf);
 159
 160         if (maj_stat1 != GSS_S_COMPLETE) {
 161                 snprintf(maj_buf, sizeof(maj_buf), "(0x%08x)", major);
 162                 maj = &maj_buf[0];
 163         } else {
 164                 maj = maj_gss_buf.value;
 165         }
 166
 167         /* Get minor status message */
 168         maj_stat2 = gss_display_status(&min_stat2, minor,
 169                 GSS_C_MECH_CODE, mech, &msg_ctx, &min_gss_buf);
 170
 171         if (maj_stat2 != GSS_S_COMPLETE) {
 172                 snprintf(min_buf, sizeof(min_buf), "(0x%08x)", minor);
 173                 min = &min_buf[0];
 174         } else {
 175                 min = min_gss_buf.value;
 176         }
 177
 178         printerr(0, "ERROR: GSS-API: error in %s(): %s - %s\n",
 179                  m, maj, min);
 180
 181         if (maj_gss_buf.length != 0)
 182                 (void) gss_release_buffer(&min_stat1, &maj_gss_buf);
 183         if (min_gss_buf.length != 0)
 184                 (void) gss_release_buffer(&min_stat2, &min_gss_buf);
 185 }
 186
 187 void
 188 pgsserr(char *msg, u_int32_t maj_stat, u_int32_t min_stat, const gss_OID mech)
 189 {
 190         display_status_2(msg, maj_stat, min_stat, mech);
 191 }
 192
 193 static
 194 int extract_realm_name(gss_buffer_desc *name, char **realm)
 195 {
 196         char *sname, *c;
 197         int   rc = 0;
 198
 199         sname = malloc(name->length + 1);
 200         if (!sname) {
 201                 printerr(0, "out of memory\n");
 202                 return -ENOMEM;
 203         }
 204
 205         memcpy(sname, name->value, name->length);
 206         sname[name->length] = '\0';
 207         printerr(1, "service principal: %s\n", sname);
 208
 209         c = strchr(sname, '@');
 210         if (!c) {
 211                 printerr(2, "no realm in principal, using '%s' instead\n",
 212                          krb5_this_realm);
 213                 *realm = strdup(krb5_this_realm);
 214                 if (!*realm) {
 215                         printerr(0, "failed to duplicate default realm\n");
 216                         rc = -ENOMEM;
 217                 }
 218         } else {
 219                 c++;
 220                 *realm = strdup(c);
 221                 if (!*realm) {
 222                         printerr(0, "failed to duplicated realm\n");
 223                         rc = -ENOMEM;
 224                 }
 225         }
 226         free(sname);
 227
 228         return rc;
 229 }
 230
 231 static
 232 int gssd_acquire_cred(char *server_name, gss_cred_id_t *cred,
 233                       char **local_realm, int *valid)
 234 {
 235         gss_buffer_desc name;
 236         gss_name_t target_name;
 237         u_int32_t maj_stat, min_stat;
 238         u_int32_t ignore_maj_stat, ignore_min_stat;
 239         gss_OID name_type;
 240         gss_buffer_desc pbuf;
 241
 242         *valid = 0;
 243
 244         name.value = (void *)server_name;
 245         name.length = strlen(server_name);
 246
 247         maj_stat = gss_import_name(&min_stat, &name,
 248                         (const gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
 249                         &target_name);
 250
 251         if (maj_stat != GSS_S_COMPLETE) {
 252                 pgsserr("gss_import_name", maj_stat, min_stat, g_mechOid);
 253                 return -1;
 254         }
 255
 256         maj_stat = gss_display_name(&min_stat, target_name, &name, &name_type);
 257         if (maj_stat != GSS_S_COMPLETE) {
 258                 pgsserr(0, maj_stat, min_stat, g_mechOid);
 259                 return -1;
 260         }
 261         if (extract_realm_name(&name, local_realm))
 262                 return -1;
 263
 264         maj_stat = gss_acquire_cred(&min_stat, target_name, 0,
 265                         GSS_C_NULL_OID_SET, GSS_C_ACCEPT,
 266                         cred, NULL, NULL);
 267
 268         if (maj_stat != GSS_S_COMPLETE) {
 269                 pgsserr("gss_acquire_cred", maj_stat, min_stat, g_mechOid);
 270                 ignore_maj_stat = gss_display_name(&ignore_min_stat,
 271                                 target_name, &pbuf, NULL);
 272                 if (ignore_maj_stat == GSS_S_COMPLETE) {
 273                         printerr(0, "Unable to obtain credentials for '%.*s'\n",
 274                                  (int) pbuf.length, (char *) pbuf.value);
 275                         ignore_maj_stat = gss_release_buffer(&ignore_min_stat,
 276                                                              &pbuf);
 277                 }
 278         } else
 279                 *valid = 1;
 280
 281         ignore_maj_stat = gss_release_name(&ignore_min_stat, &target_name);
 282
 283         if (maj_stat != GSS_S_COMPLETE)
 284                 return -1;
 285         return 0;
 286 }
 287
 288 int gssd_prepare_creds(int must_srv_mgs, int must_srv_mds, int must_srv_oss)
 289 {
 290         if (gssd_acquire_cred(GSSD_SERVICE_MGS, &gssd_cred_mgs,
 291                               &mgs_local_realm, &gssd_cred_mgs_valid)) {
 292                 if (must_srv_mgs)
 293                         return -1;
 294         }
 295
 296         if (gssd_acquire_cred(GSSD_SERVICE_MDS, &gssd_cred_mds,
 297                               &mds_local_realm, &gssd_cred_mds_valid)) {
 298                 if (must_srv_mds)
 299                         return -1;
 300         }
 301
 302         if (gssd_acquire_cred(GSSD_SERVICE_OSS, &gssd_cred_oss,
 303                               &oss_local_realm, &gssd_cred_oss_valid)) {
 304                 if (must_srv_oss)
 305                         return -1;
 306         }
 307
 308         if (!gssd_cred_mgs_valid &&
 309             !gssd_cred_mds_valid &&
 310             !gssd_cred_oss_valid) {
 311                 printerr(0, "can't obtain any service creds, exit\n");
 312                 return -1;
 313         }
 314
 315         if (gssd_cred_mgs_valid)
 316                 printerr(0, "Ready to serve Lustre MGS in realm %s\n",
 317                          mgs_local_realm ? mgs_local_realm : "N/A");
 318         if (gssd_cred_mds_valid)
 319                 printerr(0, "Ready to serve Lustre MDS in realm %s\n",
 320                          mds_local_realm ? mds_local_realm : "N/A");
 321         if (gssd_cred_oss_valid)
 322                 printerr(0, "Ready to serve Lustre OSS in realm %s\n",
 323                          oss_local_realm ? oss_local_realm : "N/A");
 324
 325         return 0;
 326 }
 327
 328 gss_cred_id_t gssd_select_svc_cred(int lustre_svc)
 329 {
 330         switch (lustre_svc) {
 331         case LUSTRE_GSS_SVC_MGS:
 332                 if (!gssd_cred_mgs_valid) {
 333                         printerr(0, "ERROR: service cred for mgs not ready\n");
 334                         return NULL;
 335                 }
 336                 return gssd_cred_mgs;
 337         case LUSTRE_GSS_SVC_MDS:
 338                 if (!gssd_cred_mds_valid) {
 339                         printerr(0, "ERROR: service cred for mds not ready\n");
 340                         return NULL;
 341                 }
 342                 printerr(2, "select mds service cred\n");
 343                 return gssd_cred_mds;
 344         case LUSTRE_GSS_SVC_OSS:
 345                 if (!gssd_cred_oss_valid) {
 346                         printerr(0, "ERROR: service cred for oss not ready\n");
 347                         return NULL;
 348                 }
 349                 printerr(2, "select oss service cred\n");
 350                 return gssd_cred_oss;
 351         default:
 352                 printerr(0, "ERROR: invalid lustre svc id %d\n", lustre_svc);
 353         }
 354
 355         return NULL;
 356 }
 357
 358 int gssd_check_mechs(void)
 359 {
 360         u_int32_t maj_stat, min_stat;
 361         gss_OID_set supported_mechs = GSS_C_NO_OID_SET;
 362         int retval = -1;
 363
 364         maj_stat = gss_indicate_mechs(&min_stat, &supported_mechs);
 365         if (maj_stat != GSS_S_COMPLETE) {
 366                 printerr(0, "Unable to obtain list of supported mechanisms. "
 367                          "Check that gss library is properly configured.\n");
 368                 goto out;
 369         }
 370         if (supported_mechs == GSS_C_NO_OID_SET ||
 371             supported_mechs->count == 0) {
 372                 printerr(0, "Unable to obtain list of supported mechanisms. "
 373                          "Check that gss library is properly configured.\n");
 374                 goto out;
 375         }
 376         maj_stat = gss_release_oid_set(&min_stat, &supported_mechs);
 377         retval = 0;
 378 out:
 379         return retval;
 380 }
 381
 382 /*********************************
 383  * FIXME should be in krb5_util.c
 384  *********************************/
 385
 386 void gssd_cleanup_realms(void)
 387 {
 388         krb5_context context = NULL;
 389         krb5_error_code code;
 390
 391         if (krb5_this_realm) {
 392                 code = krb5_init_context(&context);
 393                 if (code) {
 394                         printerr(0, "ERROR: cleanup realms: init ctx: %s\n",
 395                                  error_message(code));
 396                 } else {
 397                         krb5_free_string(context, krb5_this_realm);
 398                         krb5_this_realm = NULL;
 399                         krb5_free_context(context);
 400                 }
 401         }
 402         if (mgs_local_realm)
 403                 free(mgs_local_realm);
 404         if (mds_local_realm)
 405                 free(mds_local_realm);
 406         if (oss_local_realm)
 407                 free(oss_local_realm);
 408 }