www.project-moonshot.org Git - mech_eap.orig/blob - util_name.c

   1 /*
   2  * Copyright (c) 2011, 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 /*
  57  * Name utility routines.
  58  */
  59
  60 #include "gssapiP_eap.h"
  61
  62 static gss_OID_desc gssEapNtPrincipalName = {
  63     /* 1.3.6.1.4.1.5322.22.2.1  */
  64     10, "\x2B\x06\x01\x04\x01\xA9\x4A\x16\x02\x01"
  65 };
  66
  67 gss_OID GSS_EAP_NT_PRINCIPAL_NAME = &gssEapNtPrincipalName;
  68
  69 OM_uint32
  70 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName)
  71 {
  72     OM_uint32 tmpMinor;
  73     gss_name_t name;
  74
  75     *pName = GSS_C_NO_NAME;
  76
  77     name = (gss_name_t)GSSEAP_CALLOC(1, sizeof(*name));
  78     if (name == NULL) {
  79         *minor = ENOMEM;
  80         return GSS_S_FAILURE;
  81     }
  82
  83     if (GSSEAP_MUTEX_INIT(&name->mutex) != 0) {
  84         *minor = errno;
  85         gssEapReleaseName(&tmpMinor, &name);
  86         return GSS_S_FAILURE;
  87     }
  88
  89     *pName = name;
  90
  91     return GSS_S_COMPLETE;
  92 }
  93
  94 OM_uint32
  95 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName)
  96 {
  97     gss_name_t name;
  98     krb5_context krbContext = NULL;
  99     OM_uint32 tmpMinor;
 100
 101     *minor = 0;
 102
 103     if (pName == NULL) {
 104         return GSS_S_COMPLETE;
 105     }
 106
 107     name = *pName;
 108     if (name == GSS_C_NO_NAME) {
 109         return GSS_S_COMPLETE;
 110     }
 111
 112     GSSEAP_KRB_INIT(&krbContext);
 113     krb5_free_principal(krbContext, name->krbPrincipal);
 114
 115     gssEapReleaseAttrContext(&tmpMinor, name);
 116
 117     GSSEAP_MUTEX_DESTROY(&name->mutex);
 118     GSSEAP_FREE(name);
 119     *pName = NULL;
 120
 121     return GSS_S_COMPLETE;
 122 }
 123
 124 static OM_uint32
 125 krbPrincipalToName(OM_uint32 *minor,
 126                    krb5_principal *principal,
 127                    gss_name_t *pName)
 128 {
 129     OM_uint32 major;
 130     gss_name_t name;
 131
 132     major = gssEapAllocName(minor, &name);
 133     if (GSS_ERROR(major))
 134         return major;
 135
 136     name->krbPrincipal = *principal;
 137     *principal = NULL;
 138
 139     if (KRB_PRINC_LENGTH(name->krbPrincipal) > 1) {
 140         name->flags |= NAME_FLAG_SERVICE;
 141     } else {
 142         name->flags |= NAME_FLAG_NAI;
 143     }
 144
 145     *pName = name;
 146     *minor = 0;
 147
 148     return GSS_S_COMPLETE;
 149 }
 150
 151 static OM_uint32
 152 importServiceName(OM_uint32 *minor,
 153                   const gss_buffer_t nameBuffer,
 154                   gss_name_t *pName)
 155 {
 156     OM_uint32 major;
 157     krb5_context krbContext;
 158     krb5_principal krbPrinc;
 159     char *service, *host;
 160
 161     GSSEAP_KRB_INIT(&krbContext);
 162
 163     major = bufferToString(minor, nameBuffer, &service);
 164     if (GSS_ERROR(major))
 165         return major;
 166
 167     host = strchr(service, '@');
 168     if (host != NULL) {
 169         *host = '\0';
 170         host++;
 171     }
 172
 173     /* XXX this is probably NOT what we want to be doing */
 174     if (krb5_sname_to_principal(krbContext, host, service,
 175                                 KRB5_NT_SRV_HST, &krbPrinc) != 0) {
 176         GSSEAP_FREE(service);
 177         *minor = GSSEAP_BAD_SERVICE_NAME;
 178         return GSS_S_FAILURE;
 179     }
 180
 181     major = krbPrincipalToName(minor, &krbPrinc, pName);
 182     if (GSS_ERROR(major)) {
 183         krb5_free_principal(krbContext, krbPrinc);
 184     }
 185
 186     GSSEAP_FREE(service);
 187     return major;
 188 }
 189
 190 static OM_uint32
 191 importUserName(OM_uint32 *minor,
 192                const gss_buffer_t nameBuffer,
 193                gss_name_t *pName)
 194 {
 195     OM_uint32 major;
 196     krb5_context krbContext;
 197     krb5_principal krbPrinc;
 198     char *nameString;
 199
 200     GSSEAP_KRB_INIT(&krbContext);
 201
 202     if (nameBuffer == GSS_C_NO_BUFFER) {
 203         *minor = krb5_copy_principal(krbContext,
 204                                      krbAnonymousPrincipal(), &krbPrinc);
 205         if (*minor != 0)
 206             return GSS_S_FAILURE;
 207     } else {
 208         major = bufferToString(minor, nameBuffer, &nameString);
 209         if (GSS_ERROR(major))
 210             return major;
 211
 212         *minor = krb5_parse_name(krbContext, nameString, &krbPrinc);
 213         if (*minor != 0) {
 214             GSSEAP_FREE(nameString);
 215             return GSS_S_FAILURE;
 216         }
 217     }
 218
 219     major = krbPrincipalToName(minor, &krbPrinc, pName);
 220     if (GSS_ERROR(major)) {
 221         krb5_free_principal(krbContext, krbPrinc);
 222     }
 223
 224     GSSEAP_FREE(nameString);
 225     return major;
 226 }
 227
 228 static OM_uint32
 229 importAnonymousName(OM_uint32 *minor,
 230                     const gss_buffer_t nameBuffer GSSEAP_UNUSED,
 231                     gss_name_t *pName)
 232 {
 233     OM_uint32 major;
 234     krb5_context krbContext;
 235     krb5_principal krbPrinc;
 236
 237     GSSEAP_KRB_INIT(&krbContext);
 238
 239     *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
 240                                  &krbPrinc);
 241     if (*minor != 0)
 242         return GSS_S_FAILURE;
 243
 244     major = krbPrincipalToName(minor, &krbPrinc, pName);
 245     if (GSS_ERROR(major)) {
 246         krb5_free_principal(krbContext, krbPrinc);
 247     }
 248
 249     return major;
 250 }
 251
 252 #define UPDATE_REMAIN(n)    do {            \
 253         p += (n);                           \
 254         remain -= (n);                      \
 255     } while (0)
 256
 257 #define CHECK_REMAIN(n)     do {        \
 258         if (remain < (n)) {             \
 259             major = GSS_S_BAD_NAME;     \
 260             *minor = GSSEAP_TOK_TRUNC;  \
 261             goto cleanup;               \
 262         }                               \
 263     } while (0)
 264
 265 OM_uint32
 266 gssEapImportNameInternal(OM_uint32 *minor,
 267                          const gss_buffer_t nameBuffer,
 268                          gss_name_t *pName,
 269                          unsigned int flags)
 270 {
 271     OM_uint32 major, tmpMinor;
 272     krb5_context krbContext;
 273     unsigned char *p;
 274     size_t len, remain;
 275     gss_buffer_desc buf;
 276     enum gss_eap_token_type tokType;
 277     gss_name_t name = GSS_C_NO_NAME;
 278
 279     GSSEAP_KRB_INIT(&krbContext);
 280
 281     p = (unsigned char *)nameBuffer->value;
 282     remain = nameBuffer->length;
 283
 284     if (flags & EXPORT_NAME_FLAG_OID) {
 285         if (remain < 6 + GSS_EAP_MECHANISM->length)
 286             return GSS_S_BAD_NAME;
 287
 288         if (flags & EXPORT_NAME_FLAG_COMPOSITE)
 289             tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
 290         else
 291             tokType = TOK_TYPE_EXPORT_NAME;
 292
 293         /* TOK_ID */
 294         if (load_uint16_be(p) != tokType)
 295             return GSS_S_BAD_NAME;
 296         UPDATE_REMAIN(2);
 297
 298         /* MECH_OID_LEN */
 299         len = load_uint16_be(p);
 300         if (len != 2 + GSS_EAP_MECHANISM->length)
 301             return GSS_S_BAD_NAME;
 302         UPDATE_REMAIN(2);
 303
 304         /* MECH_OID */
 305         if (p[0] != 0x06)
 306             return GSS_S_BAD_NAME;
 307         if (p[1] != GSS_EAP_MECHANISM->length)
 308             return GSS_S_BAD_MECH;
 309         if (memcmp(&p[2], GSS_EAP_MECHANISM->elements, GSS_EAP_MECHANISM->length))
 310             return GSS_S_BAD_MECH;
 311         UPDATE_REMAIN(2 + GSS_EAP_MECHANISM->length);
 312     }
 313
 314     /* NAME_LEN */
 315     CHECK_REMAIN(4);
 316     len = load_uint32_be(p);
 317     UPDATE_REMAIN(4);
 318
 319     /* NAME */
 320     CHECK_REMAIN(len);
 321     buf.length = len;
 322     buf.value = p;
 323     UPDATE_REMAIN(len);
 324
 325     major = importUserName(minor, &buf, &name);
 326     if (GSS_ERROR(major))
 327         goto cleanup;
 328
 329     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
 330         gss_buffer_desc buf;
 331
 332         buf.length = remain;
 333         buf.value = p;
 334
 335         major = gssEapImportAttrContext(minor, &buf, name);
 336         if (GSS_ERROR(major))
 337             goto cleanup;
 338     }
 339
 340     major = GSS_S_COMPLETE;
 341     *minor = 0;
 342
 343 cleanup:
 344     if (GSS_ERROR(major))
 345         gssEapReleaseName(&tmpMinor, &name);
 346     else
 347         *pName = name;
 348
 349     return major;
 350 }
 351
 352 static OM_uint32
 353 importExportName(OM_uint32 *minor,
 354                  const gss_buffer_t nameBuffer,
 355                  gss_name_t *name)
 356 {
 357     return gssEapImportNameInternal(minor, nameBuffer, name,
 358                                     EXPORT_NAME_FLAG_OID);
 359 }
 360
 361 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
 362 static OM_uint32
 363 importCompositeExportName(OM_uint32 *minor,
 364                           const gss_buffer_t nameBuffer,
 365                           gss_name_t *name)
 366 {
 367     return gssEapImportNameInternal(minor, nameBuffer, name,
 368                                     EXPORT_NAME_FLAG_OID |
 369                                     EXPORT_NAME_FLAG_COMPOSITE);
 370 }
 371 #endif
 372
 373 struct gss_eap_name_import_provider {
 374     gss_OID oid;
 375     OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
 376 };
 377
 378 OM_uint32
 379 gssEapImportName(OM_uint32 *minor,
 380                  const gss_buffer_t nameBuffer,
 381                  gss_OID nameType,
 382                  gss_name_t *name)
 383 {
 384     struct gss_eap_name_import_provider nameTypes[] = {
 385         { GSS_C_NT_USER_NAME,               importUserName              },
 386         { GSS_EAP_NT_PRINCIPAL_NAME,        importUserName              },
 387         { GSS_C_NT_HOSTBASED_SERVICE,       importServiceName           },
 388         { GSS_C_NT_HOSTBASED_SERVICE_X,     importServiceName           },
 389         { GSS_C_NT_ANONYMOUS,               importAnonymousName         },
 390         { GSS_C_NT_EXPORT_NAME,             importExportName            },
 391 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
 392         { GSS_C_NT_COMPOSITE_EXPORT,        importCompositeExportName   },
 393 #endif
 394     };
 395     size_t i;
 396
 397     *name = GSS_C_NO_NAME;
 398
 399     if (nameType == GSS_C_NO_OID)
 400         nameType = nameTypes[0].oid;
 401
 402     for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
 403         if (oidEqual(nameTypes[i].oid, nameType))
 404             return nameTypes[i].import(minor, nameBuffer, name);
 405     }
 406
 407     return GSS_S_BAD_NAMETYPE;
 408 }
 409
 410 OM_uint32
 411 gssEapExportName(OM_uint32 *minor,
 412                  const gss_name_t name,
 413                  gss_buffer_t exportedName)
 414 {
 415     return gssEapExportNameInternal(minor, name, exportedName,
 416                                     EXPORT_NAME_FLAG_OID);
 417 }
 418
 419 OM_uint32
 420 gssEapExportNameInternal(OM_uint32 *minor,
 421                          const gss_name_t name,
 422                          gss_buffer_t exportedName,
 423                          unsigned int flags)
 424 {
 425     OM_uint32 major = GSS_S_FAILURE, tmpMinor;
 426     krb5_context krbContext;
 427     char *krbName = NULL;
 428     size_t krbNameLen, exportedNameLen;
 429     unsigned char *p;
 430     gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
 431
 432     exportedName->length = 0;
 433     exportedName->value = NULL;
 434
 435     GSSEAP_KRB_INIT(&krbContext);
 436
 437     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
 438     if (*minor != 0) {
 439         major = GSS_S_FAILURE;
 440         goto cleanup;
 441     }
 442     krbNameLen = strlen(krbName);
 443
 444     exportedNameLen = 0;
 445     if (flags & EXPORT_NAME_FLAG_OID) {
 446         exportedNameLen += 6 + GSS_EAP_MECHANISM->length;
 447     }
 448     exportedNameLen += 4 + krbNameLen;
 449     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
 450         major = gssEapExportAttrContext(minor, name, &attrs);
 451         if (GSS_ERROR(major))
 452             goto cleanup;
 453         exportedNameLen += attrs.length;
 454     }
 455
 456     exportedName->value = GSSEAP_MALLOC(exportedNameLen);
 457     if (exportedName->value == NULL) {
 458         major = GSS_S_FAILURE;
 459         *minor = ENOMEM;
 460         goto cleanup;
 461     }
 462     exportedName->length = exportedNameLen;
 463
 464     p = (unsigned char *)exportedName->value;
 465
 466     if (flags & EXPORT_NAME_FLAG_OID) {
 467         /* TOK | MECH_OID_LEN */
 468         store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
 469                         ? TOK_TYPE_EXPORT_NAME_COMPOSITE
 470                         : TOK_TYPE_EXPORT_NAME,
 471                         p);
 472         p += 2;
 473         store_uint16_be(GSS_EAP_MECHANISM->length + 2, p);
 474         p += 2;
 475
 476         /* MECH_OID */
 477         *p++ = 0x06;
 478         *p++ = GSS_EAP_MECHANISM->length & 0xff;
 479         memcpy(p, GSS_EAP_MECHANISM->elements, GSS_EAP_MECHANISM->length);
 480         p += GSS_EAP_MECHANISM->length;
 481     }
 482
 483     /* NAME_LEN */
 484     store_uint32_be(krbNameLen, p);
 485     p += 4;
 486
 487     /* NAME */
 488     memcpy(p, krbName, krbNameLen);
 489     p += krbNameLen;
 490
 491     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
 492         memcpy(p, attrs.value, attrs.length);
 493         p += attrs.length;
 494     }
 495
 496     assert(p == (unsigned char *)exportedName->value + exportedNameLen);
 497
 498     major = GSS_S_COMPLETE;
 499     *minor = 0;
 500
 501 cleanup:
 502     gss_release_buffer(&tmpMinor, &attrs);
 503     if (GSS_ERROR(major))
 504         gss_release_buffer(&tmpMinor, exportedName);
 505     krb5_free_unparsed_name(krbContext, krbName);
 506
 507     return major;
 508 }
 509
 510 OM_uint32
 511 gssEapDuplicateName(OM_uint32 *minor,
 512                     const gss_name_t input_name,
 513                     gss_name_t *dest_name)
 514 {
 515     OM_uint32 major, tmpMinor;
 516     krb5_context krbContext;
 517     gss_name_t name;
 518
 519     if (input_name == GSS_C_NO_NAME) {
 520         *minor = EINVAL;
 521         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
 522     }
 523
 524     GSSEAP_KRB_INIT(&krbContext);
 525
 526     major = gssEapAllocName(minor, &name);
 527     if (GSS_ERROR(major)) {
 528         return major;
 529     }
 530
 531     name->flags = input_name->flags;
 532
 533     *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
 534                                  &name->krbPrincipal);
 535     if (*minor != 0) {
 536         major = GSS_S_FAILURE;
 537         goto cleanup;
 538     }
 539
 540     if (input_name->attrCtx != NULL) {
 541         major = gssEapDuplicateAttrContext(minor, input_name, name);
 542         if (GSS_ERROR(major))
 543             goto cleanup;
 544     }
 545
 546     *dest_name = name;
 547
 548 cleanup:
 549     if (GSS_ERROR(major)) {
 550         gssEapReleaseName(&tmpMinor, &name);
 551     }
 552
 553     return major;
 554 }
 555
 556 OM_uint32
 557 gssEapDisplayName(OM_uint32 *minor,
 558                   gss_name_t name,
 559                   gss_buffer_t output_name_buffer,
 560                   gss_OID *output_name_type)
 561 {
 562     OM_uint32 major;
 563     krb5_context krbContext;
 564     char *krbName;
 565     gss_OID name_type;
 566
 567     GSSEAP_KRB_INIT(&krbContext);
 568
 569     output_name_buffer->length = 0;
 570     output_name_buffer->value = NULL;
 571
 572     if (name == GSS_C_NO_NAME) {
 573         *minor = EINVAL;
 574         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
 575     }
 576
 577     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
 578     if (*minor != 0) {
 579         return GSS_S_FAILURE;
 580     }
 581
 582     major = makeStringBuffer(minor, krbName, output_name_buffer);
 583     if (GSS_ERROR(major)) {
 584         krb5_free_unparsed_name(krbContext, krbName);
 585         return major;
 586     }
 587
 588     krb5_free_unparsed_name(krbContext, krbName);
 589
 590     if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
 591         krb5_principal_compare(krbContext,
 592                                name->krbPrincipal, krbAnonymousPrincipal())) {
 593         name_type = GSS_C_NT_ANONYMOUS;
 594     } else {
 595         name_type = GSS_EAP_NT_PRINCIPAL_NAME;
 596     }
 597
 598     if (output_name_type != NULL)
 599         *output_name_type = name_type;
 600
 601     return GSS_S_COMPLETE;
 602 }