util_name.c

   1 /*
   2  * Copyright (c) 2010, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32 /*
  33  * Portions Copyright 2009 by the Massachusetts Institute of Technology.
  34  * All Rights Reserved.
  35  *
  36  * Export of this software from the United States of America may
  37  *   require a specific license from the United States Government.
  38  *   It is the responsibility of any person or organization contemplating
  39  *   export to obtain such a license before exporting.
  40  *
  41  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  42  * distribute this software and its documentation for any purpose and
  43  * without fee is hereby granted, provided that the above copyright
  44  * notice appear in all copies and that both that copyright notice and
  45  * this permission notice appear in supporting documentation, and that
  46  * the name of M.I.T. not be used in advertising or publicity pertaining
  47  * to distribution of the software without specific, written prior
  48  * permission.  Furthermore if you modify this software you must label
  49  * your software as modified software and not distribute it in such a
  50  * fashion that it might be confused with the original M.I.T. software.
  51  * M.I.T. makes no representations about the suitability of
  52  * this software for any purpose.  It is provided "as is" without express
  53  * or implied warranty.
  54  */
  55
  56 #include "gssapiP_eap.h"
  57
  58 static gss_OID_desc gssEapNtPrincipalName = {
  59     /* 1.3.6.1.4.1.5322.21.2.1  */
  60     10, "\x2B\x06\x01\x04\x01\xA9\x4A\x15\x02\x01"
  61 };
  62
  63 gss_OID GSS_EAP_NT_PRINCIPAL_NAME = &gssEapNtPrincipalName;
  64
  65 OM_uint32
  66 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName)
  67 {
  68     OM_uint32 tmpMinor;
  69     gss_name_t name;
  70
  71     *pName = GSS_C_NO_NAME;
  72
  73     name = (gss_name_t)GSSEAP_CALLOC(1, sizeof(*name));
  74     if (name == NULL) {
  75         *minor = ENOMEM;
  76         return GSS_S_FAILURE;
  77     }
  78
  79     if (GSSEAP_MUTEX_INIT(&name->mutex) != 0) {
  80         *minor = errno;
  81         gssEapReleaseName(&tmpMinor, &name);
  82         return GSS_S_FAILURE;
  83     }
  84
  85     *pName = name;
  86
  87     return GSS_S_COMPLETE;
  88 }
  89
  90 OM_uint32
  91 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName)
  92 {
  93     gss_name_t name;
  94     krb5_context krbContext = NULL;
  95     OM_uint32 tmpMinor;
  96
  97     if (pName == NULL) {
  98         return GSS_S_COMPLETE;
  99     }
 100
 101     name = *pName;
 102     if (name == GSS_C_NO_NAME) {
 103         return GSS_S_COMPLETE;
 104     }
 105
 106     GSSEAP_KRB_INIT(&krbContext);
 107     krb5_free_principal(krbContext, name->krbPrincipal);
 108
 109     samlReleaseAttrContext(&tmpMinor, name);
 110     radiusReleaseAttrContext(&tmpMinor, name);
 111
 112     GSSEAP_MUTEX_DESTROY(&name->mutex);
 113     GSSEAP_FREE(name);
 114     *pName = NULL;
 115
 116     *minor = 0;
 117     return GSS_S_COMPLETE;
 118 }
 119
 120 static OM_uint32
 121 krbPrincipalToName(OM_uint32 *minor,
 122                    krb5_principal *principal,
 123                    gss_name_t *pName)
 124 {
 125     OM_uint32 major;
 126     gss_name_t name;
 127
 128     major = gssEapAllocName(minor, &name);
 129     if (GSS_ERROR(major))
 130         return major;
 131
 132     name->krbPrincipal = *principal;
 133     *principal = NULL;
 134
 135     if (name->krbPrincipal->length == 1) {
 136         name->flags |= NAME_FLAG_NAI;
 137     } else {
 138         name->flags |= NAME_FLAG_SERVICE;
 139     }
 140
 141     *pName = name;
 142     *minor = 0;
 143
 144     return GSS_S_COMPLETE;
 145 }
 146
 147 static OM_uint32
 148 importServiceName(OM_uint32 *minor,
 149                   const gss_buffer_t nameBuffer,
 150                   gss_name_t *pName)
 151 {
 152     OM_uint32 major, tmpMinor;
 153     krb5_context krbContext;
 154     krb5_principal krbPrinc;
 155     char *service, *host;
 156
 157     GSSEAP_KRB_INIT(&krbContext);
 158
 159     major = bufferToString(minor, nameBuffer, &service);
 160     if (GSS_ERROR(major))
 161         return major;
 162
 163     host = strchr(service, '@');
 164     if (host != NULL) {
 165         *host = '\0';
 166         host++;
 167     }
 168
 169     /* XXX this is probably NOT what we want to be doing */
 170     *minor = krb5_sname_to_principal(krbContext, host, service,
 171                                      KRB5_NT_SRV_HST, &krbPrinc);
 172     if (*minor != 0) {
 173         GSSEAP_FREE(service);
 174         return GSS_S_FAILURE;
 175     }
 176
 177     major = krbPrincipalToName(minor, &krbPrinc, pName);
 178     if (GSS_ERROR(major)) {
 179         krb5_free_principal(krbContext, krbPrinc);
 180     }
 181
 182     GSSEAP_FREE(service);
 183     return major;
 184 }
 185
 186 static OM_uint32
 187 importUserName(OM_uint32 *minor,
 188                const gss_buffer_t nameBuffer,
 189                gss_name_t *pName)
 190 {
 191     OM_uint32 major, tmpMinor;
 192     krb5_context krbContext;
 193     krb5_principal krbPrinc;
 194     char *nameString;
 195
 196     GSSEAP_KRB_INIT(&krbContext);
 197
 198     major = bufferToString(minor, nameBuffer, &nameString);
 199     if (GSS_ERROR(major))
 200         return major;
 201
 202     *minor = krb5_parse_name(krbContext, nameString, &krbPrinc);
 203     if (*minor != 0) {
 204         GSSEAP_FREE(nameString);
 205         return GSS_S_FAILURE;
 206     }
 207
 208     major = krbPrincipalToName(minor, &krbPrinc, pName);
 209     if (GSS_ERROR(major)) {
 210         krb5_free_principal(krbContext, krbPrinc);
 211     }
 212
 213     GSSEAP_FREE(nameString);
 214     return major;
 215 }
 216
 217 static OM_uint32
 218 importExportedName(OM_uint32 *minor,
 219                    const gss_buffer_t nameBuffer,
 220                    gss_name_t *pName)
 221 {
 222     OM_uint32 major, tmpMinor;
 223     krb5_context krbContext;
 224     unsigned char *p;
 225     size_t len, remain;
 226     gss_buffer_desc buf;
 227     enum gss_eap_token_type tok_type;
 228     gss_name_t name = GSS_C_NO_NAME;
 229
 230     GSSEAP_KRB_INIT(&krbContext);
 231
 232     p = (unsigned char *)nameBuffer->value;
 233     remain = nameBuffer->length;
 234
 235     if (remain < 6 + GSS_EAP_MECHANISM->length + 4)
 236         return GSS_S_BAD_NAME;
 237
 238 #define UPDATE_REMAIN(n)    do {            \
 239         p += (n);                           \
 240         remain -= (n);                      \
 241     } while (0)
 242
 243     /* TOK_ID */
 244     tok_type = load_uint16_be(p);
 245     if (tok_type != TOK_TYPE_EXPORT_NAME &&
 246         tok_type != TOK_TYPE_EXPORT_NAME_COMPOSITE)
 247         return GSS_S_BAD_NAME;
 248     UPDATE_REMAIN(2);
 249
 250     /* MECH_OID_LEN */
 251     len = load_uint16_be(p);
 252     if (len != 2 + GSS_EAP_MECHANISM->length)
 253         return GSS_S_BAD_NAME;
 254     UPDATE_REMAIN(2);
 255
 256     /* MECH_OID */
 257     if (p[0] != 0x06)
 258         return GSS_S_BAD_NAME;
 259     if (p[1] != GSS_EAP_MECHANISM->length)
 260         return GSS_S_BAD_MECH;
 261     if (memcmp(&p[2], GSS_EAP_MECHANISM->elements, GSS_EAP_MECHANISM->length))
 262         return GSS_S_BAD_MECH;
 263     UPDATE_REMAIN(2 + GSS_EAP_MECHANISM->length);
 264
 265     /* NAME_LEN */
 266     len = load_uint32_be(p);
 267     UPDATE_REMAIN(4);
 268
 269 #define CHECK_REMAIN(n)     do {        \
 270         if (remain < (n)) {             \
 271             *minor = ERANGE;            \
 272             major = GSS_S_BAD_NAME;     \
 273             goto cleanup;               \
 274         }                               \
 275     } while (0)
 276
 277     /* NAME */
 278     CHECK_REMAIN(len);
 279     buf.length = len;
 280     buf.value = p;
 281     UPDATE_REMAIN(len);
 282
 283     major = importUserName(minor, &buf, &name);
 284     if (GSS_ERROR(major))
 285         goto cleanup;
 286
 287     if (tok_type == TOK_TYPE_EXPORT_NAME_COMPOSITE) {
 288         gss_buffer_desc buf;
 289
 290         CHECK_REMAIN(4);
 291         name->flags = load_uint32_be(p);
 292         UPDATE_REMAIN(4);
 293
 294         if (name->flags & NAME_FLAG_RADIUS_ATTRIBUTES) {
 295             CHECK_REMAIN(4);
 296             buf.length = load_uint32_be(p);
 297             UPDATE_REMAIN(4);
 298
 299             CHECK_REMAIN(buf.length);
 300             buf.value = p;
 301             UPDATE_REMAIN(buf.length);
 302
 303             major = radiusImportAttrContext(minor, &buf, name);
 304             if (GSS_ERROR(major))
 305                 goto cleanup;
 306         }
 307
 308         if (name->flags & NAME_FLAG_SAML_ATTRIBUTES) {
 309             CHECK_REMAIN(4);
 310             buf.length = load_uint32_be(p);
 311             UPDATE_REMAIN(4);
 312
 313             CHECK_REMAIN(buf.length);
 314             buf.value = p;
 315             UPDATE_REMAIN(buf.length);
 316
 317             major = samlImportAttrContext(minor, &buf, name);
 318             if (GSS_ERROR(major))
 319                 goto cleanup;
 320         }
 321     }
 322
 323     major = GSS_S_COMPLETE;
 324
 325 cleanup:
 326     if (GSS_ERROR(major))
 327         gssEapReleaseName(&tmpMinor, &name);
 328     else
 329         *pName = name;
 330
 331     return major;
 332 }
 333
 334 OM_uint32
 335 gssEapImportName(OM_uint32 *minor,
 336                  const gss_buffer_t nameBuffer,
 337                  gss_OID nameType,
 338                  gss_name_t *name)
 339 {
 340     OM_uint32 major, tmpMinor;
 341
 342     *name = GSS_C_NO_NAME;
 343
 344     if (nameType == GSS_C_NULL_OID ||
 345         oidEqual(nameType, GSS_C_NT_USER_NAME) ||
 346         oidEqual(nameType, GSS_EAP_NT_PRINCIPAL_NAME))
 347         major = importUserName(minor, nameBuffer, name);
 348     else if (oidEqual(nameType, GSS_C_NT_HOSTBASED_SERVICE) ||
 349                oidEqual(nameType, GSS_C_NT_HOSTBASED_SERVICE_X))
 350         major = importServiceName(minor, nameBuffer, name);
 351     else if (oidEqual(nameType, GSS_C_NT_EXPORT_NAME))
 352         major = importExportedName(minor, nameBuffer, name);
 353     else
 354         major = GSS_S_BAD_NAMETYPE;
 355
 356     if (GSS_ERROR(major))
 357         gssEapReleaseName(&tmpMinor, name);
 358
 359     return major;
 360 }
 361
 362 OM_uint32
 363 gssEapExportName(OM_uint32 *minor,
 364                  const gss_name_t name,
 365                  gss_buffer_t exportedName,
 366                  int composite)
 367 {
 368     OM_uint32 major = GSS_S_FAILURE, tmpMinor;
 369     krb5_context krbContext;
 370     char *krbName = NULL;
 371     size_t krbNameLen;
 372     unsigned char *p;
 373     gss_buffer_desc radius, saml;
 374
 375     radius.length = 0;
 376     radius.value = NULL;
 377
 378     saml.length = 0;
 379     saml.value = NULL;
 380
 381     exportedName->length = 0;
 382     exportedName->value = NULL;
 383
 384     GSSEAP_KRB_INIT(&krbContext);
 385     GSSEAP_MUTEX_LOCK(&name->mutex);
 386
 387     /*
 388      * Don't export a composite name if we don't have any attributes.
 389      */
 390     if (composite && !NAME_HAS_ATTRIBUTES(name))
 391         composite = 0;
 392
 393     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
 394     if (*minor != 0) {
 395         major = GSS_S_FAILURE;
 396         goto cleanup;
 397     }
 398     krbNameLen = strlen(krbName);
 399
 400     exportedName->length = 6 + GSS_EAP_MECHANISM->length + 4 + krbNameLen;
 401     if (composite) {
 402         exportedName->length += 4;
 403
 404         if (name->flags & NAME_FLAG_RADIUS_ATTRIBUTES) {
 405             major = radiusExportAttrContext(minor, name, &radius);
 406             if (GSS_ERROR(major))
 407                 goto cleanup;
 408             exportedName->length += 4 + radius.length;
 409         }
 410         if (name->flags & NAME_FLAG_SAML_ATTRIBUTES) {
 411             major = samlExportAttrContext(minor, name, &saml);
 412             if (GSS_ERROR(major))
 413                 goto cleanup;
 414             exportedName->length += 4 + saml.length;
 415         }
 416     }
 417
 418     exportedName->value = GSSEAP_MALLOC(exportedName->length);
 419     if (exportedName->value == NULL) {
 420         major = GSS_S_FAILURE;
 421         *minor = ENOMEM;
 422         goto cleanup;
 423     }
 424
 425     /* TOK | MECH_OID_LEN */
 426     p = (unsigned char *)exportedName->value;
 427     store_uint16_be(composite
 428                         ? TOK_TYPE_EXPORT_NAME_COMPOSITE
 429                         : TOK_TYPE_EXPORT_NAME,
 430                     p);
 431     p += 2;
 432     store_uint16_be(GSS_EAP_MECHANISM->length + 2, p);
 433     p += 2;
 434
 435     /* MECH_OID */
 436     *p++ = 0x06;
 437     *p++ = GSS_EAP_MECHANISM->length & 0xff;
 438     memcpy(p, GSS_EAP_MECHANISM->elements, GSS_EAP_MECHANISM->length);
 439     p += GSS_EAP_MECHANISM->length;
 440
 441     /* NAME_LEN */
 442     store_uint32_be(krbNameLen, p);
 443     p += 4;
 444
 445     /* NAME */
 446     memcpy(p, krbName, krbNameLen);
 447     p += krbNameLen;
 448
 449     if (composite) {
 450         store_uint32_be(name->flags, p);
 451         p += 4;
 452
 453         if (name->flags & NAME_FLAG_RADIUS_ATTRIBUTES) {
 454             store_uint32_be(radius.length, p);
 455             memcpy(&p[4], radius.value, radius.length);
 456             p += 4 + radius.length;
 457         }
 458         if (name->flags & NAME_FLAG_SAML_ATTRIBUTES) {
 459             store_uint32_be(saml.length, p);
 460             memcpy(&p[4], saml.value, saml.length);
 461             p += 4 + saml.length;
 462         }
 463     }
 464
 465     *minor = 0;
 466     major = GSS_S_COMPLETE;
 467
 468 cleanup:
 469     GSSEAP_MUTEX_UNLOCK(&name->mutex);
 470     gss_release_buffer(&tmpMinor, &saml);
 471     gss_release_buffer(&tmpMinor, &radius);
 472     if (GSS_ERROR(major))
 473         gss_release_buffer(&tmpMinor, exportedName);
 474     krb5_free_unparsed_name(krbContext, krbName);
 475
 476     return major;
 477 }
 478
 479 static gss_buffer_desc attributePrefixes[] = {
 480     {
 481         /* ATTR_TYPE_NONE */
 482         0,
 483         NULL,
 484     },
 485     {
 486         /* ATTR_TYPE_SAML_AAA_ASSERTION */
 487         sizeof("urn:ietf:params:gss-eap:saml-aaa-assertion"),
 488         "urn:ietf:params:gss-eap:saml-aaa-assertion"
 489     },
 490     {
 491         /* ATTR_TYPE_SAML_ATTR */
 492         sizeof("urn:ietf:params:gss-eap:saml-attr"),
 493         "urn:ietf:params:gss-eap:saml-attr"
 494     },
 495     {
 496         /* ATTR_TYPE_RADIUS_AVP */
 497         sizeof("urn:ietf:params:gss-eap:radius-avp"),
 498         "urn:ietf:params:gss-eap:radius-avp",
 499     }
 500 };
 501
 502 enum gss_eap_attribute_type
 503 gssEapAttributePrefixToType(const gss_buffer_t prefix)
 504 {
 505     enum gss_eap_attribute_type i;
 506
 507     for (i = ATTR_TYPE_SAML_AAA_ASSERTION;
 508          i < sizeof(attributePrefixes) / sizeof(attributePrefixes[0]);
 509          i++)
 510     {
 511         if (bufferEqual(&attributePrefixes[i], prefix))
 512             return i;
 513     }
 514
 515     return ATTR_TYPE_NONE;
 516 }
 517
 518 gss_buffer_t
 519 gssEapAttributeTypeToPrefix(enum gss_eap_attribute_type type)
 520 {
 521     if (type <= ATTR_TYPE_NONE ||
 522         type > ATTR_TYPE_RADIUS_AVP)
 523         return GSS_C_NO_BUFFER;
 524
 525     return &attributePrefixes[type];
 526 }
 527
 528 OM_uint32
 529 decomposeAttributeName(OM_uint32 *minor,
 530                        const gss_buffer_t attribute,
 531                        gss_buffer_t prefix,
 532                        gss_buffer_t suffix)
 533 {
 534     char *p = NULL;
 535     int i;
 536
 537     for (i = 0; i < attribute->length; i++) {
 538         if (((char *)attribute->value)[i] == ' ') {
 539             p = (char *)attribute->value + i + 1;
 540             break;
 541         }
 542     }
 543
 544     prefix->value = attribute->value;
 545     prefix->length = i;
 546
 547     if (p != NULL && *p != '\0')  {
 548         suffix->length = attribute->length - 1 - prefix->length;
 549         suffix->value = p;
 550     } else {
 551         suffix->length = 0;
 552         suffix->value = NULL;
 553     }
 554
 555     *minor = 0;
 556     return GSS_S_COMPLETE;
 557 }
 558
 559 OM_uint32
 560 composeAttributeName(OM_uint32 *minor,
 561                        const gss_buffer_t prefix,
 562                        const gss_buffer_t suffix,
 563                        gss_buffer_t attribute)
 564 {
 565     size_t len = 0;
 566     char *p;
 567
 568     attribute->length = 0;
 569     attribute->value = NULL;
 570
 571     if (prefix == GSS_C_NO_BUFFER || prefix->length == 0)
 572         return GSS_S_COMPLETE;
 573
 574     len = prefix->length;
 575     if (suffix != NULL) {
 576         len += 1 + suffix->length;
 577     }
 578
 579     p = attribute->value = GSSEAP_MALLOC(len + 1);
 580     if (attribute->value == NULL) {
 581         *minor = ENOMEM;
 582         return GSS_S_FAILURE;
 583     }
 584     attribute->length = len;
 585
 586     memcpy(p, prefix->value, prefix->length);
 587     if (suffix != NULL) {
 588         p[prefix->length] = ' ';
 589         memcpy(p + prefix->length + 1, suffix->value, suffix->length);
 590     }
 591
 592     p[attribute->length] = '\0';
 593
 594     *minor = 0;
 595     return GSS_S_COMPLETE;
 596 }