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 <sys/file.h>
  65 #include <signal.h>
  66 #include <string.h>
  67 #include <sys/types.h>
  68 #include <sys/time.h>
  69 #include <sys/stat.h>
  70 #include <sys/socket.h>
  71 #include <netinet/in.h>
  72 #include <sys/param.h>
  73 #include <netdb.h>
  74 #include <fcntl.h>
  75 #include <gssapi/gssapi.h>
  76 #if defined(HAVE_KRB5) && !defined(GSS_C_NT_HOSTBASED_SERVICE)
  77 #include <gssapi/gssapi_generic.h>
  78 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  79 #endif
  80 #include "gss_util.h"
  81 #include "err_util.h"
  82 #include "gssd.h"
  83 #ifdef HAVE_UNISTD_H
  84 #include <unistd.h>
  85 #endif
  86 #include <stdlib.h>
  87 #ifdef HAVE_COM_ERR_H
  88 #include <com_err.h>
  89 #endif
  90 #include "lsupport.h"
  91
  92 /* Global gssd_credentials handle */
  93 gss_cred_id_t  gssd_cred_mds;
  94 gss_cred_id_t  gssd_cred_oss;
  95 int            gssd_cred_mds_valid = 0;
  96 int            gssd_cred_oss_valid = 0;
  97
  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 found in principal, use default\n");
 212                 *realm = strdup(this_realm);
 213                 if (!*realm) {
 214                         printerr(0, "failed to duplicate default realm\n");
 215                         rc = -ENOMEM;
 216                 }
 217         } else {
 218                 c++;
 219                 *realm = strdup(c);
 220                 if (!*realm) {
 221                         printerr(0, "failed to duplicated realm\n");
 222                         rc = -ENOMEM;
 223                 }
 224         }
 225         free(sname);
 226
 227         return rc;
 228 }
 229
 230 static
 231 int gssd_acquire_cred(char *server_name, gss_cred_id_t *cred,
 232                       char **local_realm, int *valid)
 233 {
 234         gss_buffer_desc name;
 235         gss_name_t target_name;
 236         u_int32_t maj_stat, min_stat;
 237         u_int32_t ignore_maj_stat, ignore_min_stat;
 238         gss_OID name_type;
 239         gss_buffer_desc pbuf;
 240
 241         *valid = 0;
 242
 243         name.value = (void *)server_name;
 244         name.length = strlen(server_name);
 245
 246         maj_stat = gss_import_name(&min_stat, &name,
 247                         (const gss_OID) GSS_C_NT_HOSTBASED_SERVICE,
 248                         &target_name);
 249
 250         if (maj_stat != GSS_S_COMPLETE) {
 251                 pgsserr("gss_import_name", maj_stat, min_stat, g_mechOid);
 252                 return -1;
 253         }
 254
 255         maj_stat = gss_display_name(&min_stat, target_name, &name, &name_type);
 256         if (maj_stat != GSS_S_COMPLETE) {
 257                 pgsserr(0, maj_stat, min_stat, g_mechOid);
 258                 return -1;
 259         }
 260         if (extract_realm_name(&name, local_realm))
 261                 return -1;
 262
 263         maj_stat = gss_acquire_cred(&min_stat, target_name, 0,
 264                         GSS_C_NULL_OID_SET, GSS_C_ACCEPT,
 265                         cred, NULL, NULL);
 266
 267         if (maj_stat != GSS_S_COMPLETE) {
 268                 pgsserr("gss_acquire_cred", maj_stat, min_stat, g_mechOid);
 269                 ignore_maj_stat = gss_display_name(&ignore_min_stat,
 270                                 target_name, &pbuf, NULL);
 271                 if (ignore_maj_stat == GSS_S_COMPLETE) {
 272                         printerr(0, "Unable to obtain credentials for '%.*s'\n",
 273                                  pbuf.length, pbuf.value);
 274                         ignore_maj_stat = gss_release_buffer(&ignore_min_stat,
 275                                                              &pbuf);
 276                 }
 277         } else
 278                 *valid = 1;
 279
 280         ignore_maj_stat = gss_release_name(&ignore_min_stat, &target_name);
 281
 282         if (maj_stat != GSS_S_COMPLETE)
 283                 return -1;
 284         return 0;
 285 }
 286
 287 int gssd_prepare_creds(int must_srv_mds, int must_srv_oss)
 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_mds_valid && !gssd_cred_oss_valid) {
 302                 printerr(0, "can't obtain both mds & oss creds, exit\n");
 303                 return -1;
 304         }
 305
 306         if (gssd_cred_mds_valid)
 307                 printerr(0, "Ready to serve Lustre MDS in realm %s\n",
 308                          mds_local_realm ? mds_local_realm : "N/A");
 309         if (gssd_cred_oss_valid)
 310                 printerr(0, "Ready to serve Lustre OSS in realm %s\n",
 311                          oss_local_realm ? oss_local_realm : "N/A");
 312
 313         return 0;
 314 }
 315
 316 gss_cred_id_t gssd_select_svc_cred(int lustre_svc)
 317 {
 318         switch (lustre_svc) {
 319         case LUSTRE_GSS_SVC_MDS:
 320                 if (!gssd_cred_mds_valid) {
 321                         printerr(0, "ERROR: service cred for mds not ready\n");
 322                         return NULL;
 323                 }
 324                 printerr(2, "select mds service cred\n");
 325                 return gssd_cred_mds;
 326         case LUSTRE_GSS_SVC_OSS:
 327                 if (!gssd_cred_oss_valid) {
 328                         printerr(0, "ERROR: service cred for oss not ready\n");
 329                         return NULL;
 330                 }
 331                 printerr(2, "select oss service cred\n");
 332                 return gssd_cred_oss;
 333         default:
 334                 printerr(0, "ERROR: invalid lustre svc id %d\n", lustre_svc);
 335         }
 336
 337         return NULL;
 338 }
 339
 340 int gssd_check_mechs(void)
 341 {
 342         u_int32_t maj_stat, min_stat;
 343         gss_OID_set supported_mechs = GSS_C_NO_OID_SET;
 344         int retval = -1;
 345
 346         maj_stat = gss_indicate_mechs(&min_stat, &supported_mechs);
 347         if (maj_stat != GSS_S_COMPLETE) {
 348                 printerr(0, "Unable to obtain list of supported mechanisms. "
 349                          "Check that gss library is properly configured.\n");
 350                 goto out;
 351         }
 352         if (supported_mechs == GSS_C_NO_OID_SET ||
 353             supported_mechs->count == 0) {
 354                 printerr(0, "Unable to obtain list of supported mechanisms. "
 355                          "Check that gss library is properly configured.\n");
 356                 goto out;
 357         }
 358         maj_stat = gss_release_oid_set(&min_stat, &supported_mechs);
 359         retval = 0;
 360 out:
 361         return retval;
 362 }
 363
 364 /*********************************
 365  * FIXME should be in krb5_util.c
 366  *********************************/
 367
 368 #include "krb5_util.h"
 369
 370 /* realm of this node */
 371 char *this_realm = NULL;
 372
 373 int gssd_get_local_realm(void)
 374 {
 375         krb5_context context = NULL;
 376         krb5_error_code code;
 377         int retval = -1;
 378
 379         if (this_realm != NULL)
 380                 return 0;
 381
 382         code = krb5_init_context(&context);
 383         if (code) {
 384                 printerr(0, "ERROR: get default realm: init ctx: %s\n",
 385                          error_message(code));
 386                 goto out;
 387         }
 388
 389         code = krb5_get_default_realm(context, &this_realm);
 390         if (code) {
 391                 printerr(0, "ERROR: get default realm: %s\n",
 392                          error_message(code));
 393                 goto out;
 394         }
 395         retval = 0;
 396
 397         printerr(1, "Local realm: %s\n", this_realm);
 398 out:
 399         krb5_free_context(context);
 400         return retval;
 401 }
 402