source4/heimdal/lib/krb5/context.c

   1 /*
   2  * Copyright (c) 1997 - 2005 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include "krb5_locl.h"
  35 #include <com_err.h>
  36
  37 #define INIT_FIELD(C, T, E, D, F)                                       \
  38     (C)->E = krb5_config_get_ ## T ## _default ((C), NULL, (D),         \
  39                                                 "libdefaults", F, NULL)
  40
  41 #define INIT_FLAG(C, O, V, D, F)                                        \
  42     do {                                                                \
  43         if (krb5_config_get_bool_default((C), NULL, (D),"libdefaults", F, NULL)) { \
  44             (C)->O |= V;                                                \
  45         }                                                               \
  46     } while(0)
  47
  48 /*
  49  * Set the list of etypes `ret_etypes' from the configuration variable
  50  * `name'
  51  */
  52
  53 static krb5_error_code
  54 set_etypes (krb5_context context,
  55             const char *name,
  56             krb5_enctype **ret_enctypes)
  57 {
  58     char **etypes_str;
  59     krb5_enctype *etypes = NULL;
  60
  61     etypes_str = krb5_config_get_strings(context, NULL, "libdefaults",
  62                                          name, NULL);
  63     if(etypes_str){
  64         int i, j, k;
  65         for(i = 0; etypes_str[i]; i++);
  66         etypes = malloc((i+1) * sizeof(*etypes));
  67         if (etypes == NULL) {
  68             krb5_config_free_strings (etypes_str);
  69             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
  70             return ENOMEM;
  71         }
  72         for(j = 0, k = 0; j < i; j++) {
  73             krb5_enctype e;
  74             if(krb5_string_to_enctype(context, etypes_str[j], &e) != 0)
  75                 continue;
  76             if (krb5_enctype_valid(context, e) != 0)
  77                 continue;
  78             etypes[k++] = e;
  79         }
  80         etypes[k] = ETYPE_NULL;
  81         krb5_config_free_strings(etypes_str);
  82     }
  83     *ret_enctypes = etypes;
  84     return 0;
  85 }
  86
  87 /*
  88  * read variables from the configuration file and set in `context'
  89  */
  90
  91 static krb5_error_code
  92 init_context_from_config_file(krb5_context context)
  93 {
  94     krb5_error_code ret;
  95     const char * tmp;
  96     char **s;
  97     krb5_enctype *tmptypes;
  98
  99     INIT_FIELD(context, time, max_skew, 5 * 60, "clockskew");
 100     INIT_FIELD(context, time, kdc_timeout, 3, "kdc_timeout");
 101     INIT_FIELD(context, int, max_retries, 3, "max_retries");
 102
 103     INIT_FIELD(context, string, http_proxy, NULL, "http_proxy");
 104
 105     ret = set_etypes (context, "default_etypes", &tmptypes);
 106     if(ret)
 107         return ret;
 108     free(context->etypes);
 109     context->etypes = tmptypes;
 110
 111     ret = set_etypes (context, "default_etypes_des", &tmptypes);
 112     if(ret)
 113         return ret;
 114     free(context->etypes_des);
 115     context->etypes_des = tmptypes;
 116
 117     /* default keytab name */
 118     tmp = NULL;
 119     if(!issuid())
 120         tmp = getenv("KRB5_KTNAME");
 121     if(tmp != NULL)
 122         context->default_keytab = tmp;
 123     else
 124         INIT_FIELD(context, string, default_keytab,
 125                    KEYTAB_DEFAULT, "default_keytab_name");
 126
 127     INIT_FIELD(context, string, default_keytab_modify,
 128                NULL, "default_keytab_modify_name");
 129
 130     INIT_FIELD(context, string, time_fmt,
 131                "%Y-%m-%dT%H:%M:%S", "time_format");
 132
 133     INIT_FIELD(context, string, date_fmt,
 134                "%Y-%m-%d", "date_format");
 135
 136     INIT_FIELD(context, bool, log_utc,
 137                FALSE, "log_utc");
 138
 139
 140
 141     /* init dns-proxy slime */
 142     tmp = krb5_config_get_string(context, NULL, "libdefaults",
 143                                  "dns_proxy", NULL);
 144     if(tmp)
 145         roken_gethostby_setup(context->http_proxy, tmp);
 146     krb5_free_host_realm (context, context->default_realms);
 147     context->default_realms = NULL;
 148
 149     {
 150         krb5_addresses addresses;
 151         char **adr, **a;
 152
 153         krb5_set_extra_addresses(context, NULL);
 154         adr = krb5_config_get_strings(context, NULL,
 155                                       "libdefaults",
 156                                       "extra_addresses",
 157                                       NULL);
 158         memset(&addresses, 0, sizeof(addresses));
 159         for(a = adr; a && *a; a++) {
 160             ret = krb5_parse_address(context, *a, &addresses);
 161             if (ret == 0) {
 162                 krb5_add_extra_addresses(context, &addresses);
 163                 krb5_free_addresses(context, &addresses);
 164             }
 165         }
 166         krb5_config_free_strings(adr);
 167
 168         krb5_set_ignore_addresses(context, NULL);
 169         adr = krb5_config_get_strings(context, NULL,
 170                                       "libdefaults",
 171                                       "ignore_addresses",
 172                                       NULL);
 173         memset(&addresses, 0, sizeof(addresses));
 174         for(a = adr; a && *a; a++) {
 175             ret = krb5_parse_address(context, *a, &addresses);
 176             if (ret == 0) {
 177                 krb5_add_ignore_addresses(context, &addresses);
 178                 krb5_free_addresses(context, &addresses);
 179             }
 180         }
 181         krb5_config_free_strings(adr);
 182     }
 183
 184     INIT_FIELD(context, bool, scan_interfaces, TRUE, "scan_interfaces");
 185     INIT_FIELD(context, int, fcache_vno, 0, "fcache_version");
 186     /* prefer dns_lookup_kdc over srv_lookup. */
 187     INIT_FIELD(context, bool, srv_lookup, TRUE, "srv_lookup");
 188     INIT_FIELD(context, bool, srv_lookup, context->srv_lookup, "dns_lookup_kdc");
 189     INIT_FIELD(context, int, large_msg_size, 1400, "large_message_size");
 190     INIT_FLAG(context, flags, KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME, TRUE, "dns_canonicalize_hostname");
 191     INIT_FLAG(context, flags, KRB5_CTX_F_CHECK_PAC, TRUE, "check_pac");
 192     context->default_cc_name = NULL;
 193     context->default_cc_name_set = 0;
 194
 195     ret = krb5_config_get_bool_default(context, NULL, FALSE,
 196                                        "libdefaults",
 197                                        "allow_weak_crypto", NULL);
 198     if (ret) {
 199         krb5_enctype_enable(context, ETYPE_DES_CBC_CRC);
 200         krb5_enctype_enable(context, ETYPE_DES_CBC_MD4);
 201         krb5_enctype_enable(context, ETYPE_DES_CBC_MD5);
 202         krb5_enctype_enable(context, ETYPE_DES_CBC_NONE);
 203         krb5_enctype_enable(context, ETYPE_DES_CFB64_NONE);
 204         krb5_enctype_enable(context, ETYPE_DES_PCBC_NONE);
 205     }
 206
 207     s = krb5_config_get_strings(context, NULL, "logging", "krb5", NULL);
 208     if(s) {
 209         char **p;
 210         krb5_initlog(context, "libkrb5", &context->debug_dest);
 211         for(p = s; *p; p++)
 212             krb5_addlog_dest(context, context->debug_dest, *p);
 213         krb5_config_free_strings(s);
 214     }
 215
 216
 217     return 0;
 218 }
 219
 220 static krb5_error_code
 221 cc_ops_register(krb5_context context)
 222 {
 223     context->cc_ops = NULL;
 224     context->num_cc_ops = 0;
 225
 226     krb5_cc_register(context, &krb5_acc_ops, TRUE);
 227     krb5_cc_register(context, &krb5_fcc_ops, TRUE);
 228     krb5_cc_register(context, &krb5_mcc_ops, TRUE);
 229     krb5_cc_register(context, &krb5_scc_ops, TRUE);
 230 #ifdef HAVE_KCM
 231     krb5_cc_register(context, &krb5_kcm_ops, TRUE);
 232 #endif
 233     return 0;
 234 }
 235
 236 static krb5_error_code
 237 kt_ops_register(krb5_context context)
 238 {
 239     context->num_kt_types = 0;
 240     context->kt_types     = NULL;
 241
 242     krb5_kt_register (context, &krb5_fkt_ops);
 243     krb5_kt_register (context, &krb5_wrfkt_ops);
 244     krb5_kt_register (context, &krb5_javakt_ops);
 245     krb5_kt_register (context, &krb5_mkt_ops);
 246 #ifndef HEIMDAL_SMALLER
 247     krb5_kt_register (context, &krb5_akf_ops);
 248 #endif
 249     krb5_kt_register (context, &krb5_any_ops);
 250     return 0;
 251 }
 252
 253
 254 /**
 255  * Initializes the context structure and reads the configuration file
 256  * /etc/krb5.conf. The structure should be freed by calling
 257  * krb5_free_context() when it is no longer being used.
 258  *
 259  * @param context pointer to returned context
 260  *
 261  * @return Returns 0 to indicate success.  Otherwise an errno code is
 262  * returned.  Failure means either that something bad happened during
 263  * initialization (typically ENOMEM) or that Kerberos should not be
 264  * used ENXIO.
 265  *
 266  * @ingroup krb5
 267  */
 268
 269 krb5_error_code KRB5_LIB_FUNCTION
 270 krb5_init_context(krb5_context *context)
 271 {
 272     krb5_context p;
 273     krb5_error_code ret;
 274     char **files;
 275
 276     *context = NULL;
 277
 278     /* should have a run_once */
 279     bindtextdomain(HEIMDAL_TEXTDOMAIN, HEIMDAL_LOCALEDIR);
 280
 281     p = calloc(1, sizeof(*p));
 282     if(!p)
 283         return ENOMEM;
 284
 285     p->mutex = malloc(sizeof(HEIMDAL_MUTEX));
 286     if (p->mutex == NULL) {
 287         free(p);
 288         return ENOMEM;
 289     }
 290     HEIMDAL_MUTEX_init(p->mutex);
 291
 292     p->flags |= KRB5_CTX_F_HOMEDIR_ACCESS;
 293
 294     ret = krb5_get_default_config_files(&files);
 295     if(ret)
 296         goto out;
 297     ret = krb5_set_config_files(p, files);
 298     krb5_free_config_files(files);
 299     if(ret)
 300         goto out;
 301
 302     /* init error tables */
 303     krb5_init_ets(p);
 304     cc_ops_register(p);
 305     kt_ops_register(p);
 306
 307 #ifdef PKINIT
 308     ret = hx509_context_init(&p->hx509ctx);
 309     if (ret)
 310         goto out;
 311 #endif
 312
 313 out:
 314     if(ret) {
 315         krb5_free_context(p);
 316         p = NULL;
 317     }
 318     *context = p;
 319     return ret;
 320 }
 321
 322 #ifndef HEIMDAL_SMALLER
 323
 324 /*
 325  *
 326  */
 327
 328 static krb5_error_code
 329 copy_etypes (krb5_context context,
 330              krb5_enctype *enctypes,
 331              krb5_enctype **ret_enctypes)
 332 {
 333     unsigned int i;
 334
 335     for (i = 0; enctypes[i]; i++)
 336         ;
 337     i++;
 338
 339     *ret_enctypes = malloc(sizeof(ret_enctypes[0]) * i);
 340     if (*ret_enctypes == NULL) {
 341         krb5_set_error_message(context, ENOMEM,
 342                                N_("malloc: out of memory", ""));
 343         return ENOMEM;
 344     }
 345     memcpy(*ret_enctypes, enctypes, sizeof(ret_enctypes[0]) * i);
 346     return 0;
 347 }
 348
 349 /**
 350  * Make a copy for the Kerberos 5 context, the new krb5_context shoud
 351  * be freed with krb5_free_context().
 352  *
 353  * @param context the Kerberos context to copy
 354  * @param out the copy of the Kerberos, set to NULL error.
 355  *
 356  * @return Returns 0 to indicate success.  Otherwise an kerberos et
 357  * error code is returned, see krb5_get_error_message().
 358  *
 359  * @ingroup krb5
 360  */
 361
 362 krb5_error_code KRB5_LIB_FUNCTION
 363 krb5_copy_context(krb5_context context, krb5_context *out)
 364 {
 365     krb5_error_code ret;
 366     krb5_context p;
 367
 368     *out = NULL;
 369
 370     p = calloc(1, sizeof(*p));
 371     if (p == NULL) {
 372         krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
 373         return ENOMEM;
 374     }
 375
 376     p->mutex = malloc(sizeof(HEIMDAL_MUTEX));
 377     if (p->mutex == NULL) {
 378         krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
 379         free(p);
 380         return ENOMEM;
 381     }
 382     HEIMDAL_MUTEX_init(p->mutex);
 383
 384
 385     if (context->default_cc_name)
 386         p->default_cc_name = strdup(context->default_cc_name);
 387     if (context->default_cc_name_env)
 388         p->default_cc_name_env = strdup(context->default_cc_name_env);
 389
 390     if (context->etypes) {
 391         ret = copy_etypes(context, context->etypes, &p->etypes);
 392         if (ret)
 393             goto out;
 394     }
 395     if (context->etypes_des) {
 396         ret = copy_etypes(context, context->etypes_des, &p->etypes_des);
 397         if (ret)
 398             goto out;
 399     }
 400
 401     if (context->default_realms) {
 402         ret = krb5_copy_host_realm(context,
 403                                    context->default_realms, &p->default_realms);
 404         if (ret)
 405             goto out;
 406     }
 407
 408     ret = _krb5_config_copy(context, context->cf, &p->cf);
 409     if (ret)
 410         goto out;
 411
 412     /* XXX should copy */
 413     krb5_init_ets(p);
 414     cc_ops_register(p);
 415     kt_ops_register(p);
 416
 417 #if 0 /* XXX */
 418     if(context->warn_dest != NULL)
 419         ;
 420     if(context->debug_dest != NULL)
 421         ;
 422 #endif
 423
 424     ret = krb5_set_extra_addresses(p, context->extra_addresses);
 425     if (ret)
 426         goto out;
 427     ret = krb5_set_extra_addresses(p, context->ignore_addresses);
 428     if (ret)
 429         goto out;
 430
 431     ret = _krb5_copy_send_to_kdc_func(p, context);
 432     if (ret)
 433         goto out;
 434
 435     *out = p;
 436
 437     return 0;
 438
 439  out:
 440     krb5_free_context(p);
 441     return ret;
 442 }
 443
 444 #endif
 445
 446 /**
 447  * Frees the krb5_context allocated by krb5_init_context().
 448  *
 449  * @param context context to be freed.
 450  *
 451  * @ingroup krb5
 452  */
 453
 454 void KRB5_LIB_FUNCTION
 455 krb5_free_context(krb5_context context)
 456 {
 457     if (context->default_cc_name)
 458         free(context->default_cc_name);
 459     if (context->default_cc_name_env)
 460         free(context->default_cc_name_env);
 461     free(context->etypes);
 462     free(context->etypes_des);
 463     krb5_free_host_realm (context, context->default_realms);
 464     krb5_config_file_free (context, context->cf);
 465     free_error_table (context->et_list);
 466     free(context->cc_ops);
 467     free(context->kt_types);
 468     krb5_clear_error_message(context);
 469     if(context->warn_dest != NULL)
 470         krb5_closelog(context, context->warn_dest);
 471     if(context->debug_dest != NULL)
 472         krb5_closelog(context, context->debug_dest);
 473     krb5_set_extra_addresses(context, NULL);
 474     krb5_set_ignore_addresses(context, NULL);
 475     krb5_set_send_to_kdc_func(context, NULL, NULL);
 476
 477 #ifdef PKINIT
 478     hx509_context_free(&context->hx509ctx);
 479 #endif
 480
 481     HEIMDAL_MUTEX_destroy(context->mutex);
 482     free(context->mutex);
 483
 484     memset(context, 0, sizeof(*context));
 485     free(context);
 486 }
 487
 488 /**
 489  * Reinit the context from a new set of filenames.
 490  *
 491  * @param context context to add configuration too.
 492  * @param filenames array of filenames, end of list is indicated with a NULL filename.
 493  *
 494  * @return Returns 0 to indicate success.  Otherwise an kerberos et
 495  * error code is returned, see krb5_get_error_message().
 496  *
 497  * @ingroup krb5
 498  */
 499
 500 krb5_error_code KRB5_LIB_FUNCTION
 501 krb5_set_config_files(krb5_context context, char **filenames)
 502 {
 503     krb5_error_code ret;
 504     krb5_config_binding *tmp = NULL;
 505     while(filenames != NULL && *filenames != NULL && **filenames != '\0') {
 506         ret = krb5_config_parse_file_multi(context, *filenames, &tmp);
 507         if(ret != 0 && ret != ENOENT && ret != EACCES) {
 508             krb5_config_file_free(context, tmp);
 509             return ret;
 510         }
 511         filenames++;
 512     }
 513 #if 0
 514     /* with this enabled and if there are no config files, Kerberos is
 515        considererd disabled */
 516     if(tmp == NULL)
 517         return ENXIO;
 518 #endif
 519     krb5_config_file_free(context, context->cf);
 520     context->cf = tmp;
 521     ret = init_context_from_config_file(context);
 522     return ret;
 523 }
 524
 525 static krb5_error_code
 526 add_file(char ***pfilenames, int *len, char *file)
 527 {
 528     char **pp = *pfilenames;
 529     int i;
 530
 531     for(i = 0; i < *len; i++) {
 532         if(strcmp(pp[i], file) == 0) {
 533             free(file);
 534             return 0;
 535         }
 536     }
 537
 538     pp = realloc(*pfilenames, (*len + 2) * sizeof(*pp));
 539     if (pp == NULL) {
 540         free(file);
 541         return ENOMEM;
 542     }
 543
 544     pp[*len] = file;
 545     pp[*len + 1] = NULL;
 546     *pfilenames = pp;
 547     *len += 1;
 548     return 0;
 549 }
 550
 551 /*
 552  *  `pq' isn't free, it's up the the caller
 553  */
 554
 555 krb5_error_code KRB5_LIB_FUNCTION
 556 krb5_prepend_config_files(const char *filelist, char **pq, char ***ret_pp)
 557 {
 558     krb5_error_code ret;
 559     const char *p, *q;
 560     char **pp;
 561     int len;
 562     char *fn;
 563
 564     pp = NULL;
 565
 566     len = 0;
 567     p = filelist;
 568     while(1) {
 569         ssize_t l;
 570         q = p;
 571         l = strsep_copy(&q, ":", NULL, 0);
 572         if(l == -1)
 573             break;
 574         fn = malloc(l + 1);
 575         if(fn == NULL) {
 576             krb5_free_config_files(pp);
 577             return ENOMEM;
 578         }
 579         (void)strsep_copy(&p, ":", fn, l + 1);
 580         ret = add_file(&pp, &len, fn);
 581         if (ret) {
 582             krb5_free_config_files(pp);
 583             return ret;
 584         }
 585     }
 586
 587     if (pq != NULL) {
 588         int i;
 589
 590         for (i = 0; pq[i] != NULL; i++) {
 591             fn = strdup(pq[i]);
 592             if (fn == NULL) {
 593                 krb5_free_config_files(pp);
 594                 return ENOMEM;
 595             }
 596             ret = add_file(&pp, &len, fn);
 597             if (ret) {
 598                 krb5_free_config_files(pp);
 599                 return ret;
 600             }
 601         }
 602     }
 603
 604     *ret_pp = pp;
 605     return 0;
 606 }
 607
 608 /**
 609  * Prepend the filename to the global configuration list.
 610  *
 611  * @param filelist a filename to add to the default list of filename
 612  * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
 613  *
 614  * @return Returns 0 to indicate success.  Otherwise an kerberos et
 615  * error code is returned, see krb5_get_error_message().
 616  *
 617  * @ingroup krb5
 618  */
 619
 620 krb5_error_code KRB5_LIB_FUNCTION
 621 krb5_prepend_config_files_default(const char *filelist, char ***pfilenames)
 622 {
 623     krb5_error_code ret;
 624     char **defpp, **pp = NULL;
 625
 626     ret = krb5_get_default_config_files(&defpp);
 627     if (ret)
 628         return ret;
 629
 630     ret = krb5_prepend_config_files(filelist, defpp, &pp);
 631     krb5_free_config_files(defpp);
 632     if (ret) {
 633         return ret;
 634     }
 635     *pfilenames = pp;
 636     return 0;
 637 }
 638
 639 /**
 640  * Get the global configuration list.
 641  *
 642  * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
 643  *
 644  * @return Returns 0 to indicate success.  Otherwise an kerberos et
 645  * error code is returned, see krb5_get_error_message().
 646  *
 647  * @ingroup krb5
 648  */
 649
 650 krb5_error_code KRB5_LIB_FUNCTION
 651 krb5_get_default_config_files(char ***pfilenames)
 652 {
 653     const char *files = NULL;
 654
 655     if (pfilenames == NULL)
 656         return EINVAL;
 657     if(!issuid())
 658         files = getenv("KRB5_CONFIG");
 659     if (files == NULL)
 660         files = krb5_config_file;
 661
 662     return krb5_prepend_config_files(files, NULL, pfilenames);
 663 }
 664
 665 /**
 666  * Free a list of configuration files.
 667  *
 668  * @param filenames list, terminated with a NULL pointer, to be
 669  * freed. NULL is an valid argument.
 670  *
 671  * @return Returns 0 to indicate success. Otherwise an kerberos et
 672  * error code is returned, see krb5_get_error_message().
 673  *
 674  * @ingroup krb5
 675  */
 676
 677 void KRB5_LIB_FUNCTION
 678 krb5_free_config_files(char **filenames)
 679 {
 680     char **p;
 681     for(p = filenames; p && *p != NULL; p++)
 682         free(*p);
 683     free(filenames);
 684 }
 685
 686 /**
 687  * Returns the list of Kerberos encryption types sorted in order of
 688  * most preferred to least preferred encryption type.  Note that some
 689  * encryption types might be disabled, so you need to check with
 690  * krb5_enctype_valid() before using the encryption type.
 691  *
 692  * @return list of enctypes, terminated with ETYPE_NULL. Its a static
 693  * array completed into the Kerberos library so the content doesn't
 694  * need to be freed.
 695  *
 696  * @ingroup krb5
 697  */
 698
 699 const krb5_enctype * KRB5_LIB_FUNCTION
 700 krb5_kerberos_enctypes(krb5_context context)
 701 {
 702     static const krb5_enctype p[] = {
 703         ETYPE_AES256_CTS_HMAC_SHA1_96,
 704         ETYPE_AES128_CTS_HMAC_SHA1_96,
 705         ETYPE_DES3_CBC_SHA1,
 706         ETYPE_DES3_CBC_MD5,
 707         ETYPE_ARCFOUR_HMAC_MD5,
 708         ETYPE_DES_CBC_MD5,
 709         ETYPE_DES_CBC_MD4,
 710         ETYPE_DES_CBC_CRC,
 711         ETYPE_NULL
 712     };
 713     return p;
 714 }
 715
 716 /*
 717  * set `etype' to a malloced list of the default enctypes
 718  */
 719
 720 static krb5_error_code
 721 default_etypes(krb5_context context, krb5_enctype **etype)
 722 {
 723     const krb5_enctype *p;
 724     krb5_enctype *e = NULL, *ep;
 725     int i, n = 0;
 726
 727     p = krb5_kerberos_enctypes(context);
 728
 729     for (i = 0; p[i] != ETYPE_NULL; i++) {
 730         if (krb5_enctype_valid(context, p[i]) != 0)
 731             continue;
 732         ep = realloc(e, (n + 2) * sizeof(*e));
 733         if (ep == NULL) {
 734             free(e);
 735             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
 736             return ENOMEM;
 737         }
 738         e = ep;
 739         e[n] = p[i];
 740         e[n + 1] = ETYPE_NULL;
 741         n++;
 742     }
 743     *etype = e;
 744     return 0;
 745 }
 746
 747 /**
 748  * Set the default encryption types that will be use in communcation
 749  * with the KDC, clients and servers.
 750  *
 751  * @param context Kerberos 5 context.
 752  * @param etypes Encryption types, array terminated with ETYPE_NULL (0).
 753  *
 754  * @return Returns 0 to indicate success. Otherwise an kerberos et
 755  * error code is returned, see krb5_get_error_message().
 756  *
 757  * @ingroup krb5
 758  */
 759
 760 krb5_error_code KRB5_LIB_FUNCTION
 761 krb5_set_default_in_tkt_etypes(krb5_context context,
 762                                const krb5_enctype *etypes)
 763 {
 764     krb5_enctype *p = NULL;
 765     int i;
 766
 767     if(etypes) {
 768         for (i = 0; etypes[i]; ++i) {
 769             krb5_error_code ret;
 770             ret = krb5_enctype_valid(context, etypes[i]);
 771             if (ret)
 772                 return ret;
 773         }
 774         ++i;
 775         ALLOC(p, i);
 776         if(!p) {
 777             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
 778             return ENOMEM;
 779         }
 780         memmove(p, etypes, i * sizeof(krb5_enctype));
 781     }
 782     if(context->etypes)
 783         free(context->etypes);
 784     context->etypes = p;
 785     return 0;
 786 }
 787
 788 /**
 789  * Get the default encryption types that will be use in communcation
 790  * with the KDC, clients and servers.
 791  *
 792  * @param context Kerberos 5 context.
 793  * @param etypes Encryption types, array terminated with
 794  * ETYPE_NULL(0), caller should free array with krb5_xfree():
 795  *
 796  * @return Returns 0 to indicate success. Otherwise an kerberos et
 797  * error code is returned, see krb5_get_error_message().
 798  *
 799  * @ingroup krb5
 800  */
 801
 802 krb5_error_code KRB5_LIB_FUNCTION
 803 krb5_get_default_in_tkt_etypes(krb5_context context,
 804                                krb5_enctype **etypes)
 805 {
 806     krb5_enctype *p;
 807     int i;
 808     krb5_error_code ret;
 809
 810     if(context->etypes) {
 811         for(i = 0; context->etypes[i]; i++);
 812         ++i;
 813         ALLOC(p, i);
 814         if(!p) {
 815             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
 816             return ENOMEM;
 817         }
 818         memmove(p, context->etypes, i * sizeof(krb5_enctype));
 819     } else {
 820         ret = default_etypes(context, &p);
 821         if (ret)
 822             return ret;
 823     }
 824     *etypes = p;
 825     return 0;
 826 }
 827
 828 /**
 829  * Init the built-in ets in the Kerberos library.
 830  *
 831  * @param context kerberos context to add the ets too
 832  *
 833  * @ingroup krb5
 834  */
 835
 836 void KRB5_LIB_FUNCTION
 837 krb5_init_ets(krb5_context context)
 838 {
 839     if(context->et_list == NULL){
 840         krb5_add_et_list(context, initialize_krb5_error_table_r);
 841         krb5_add_et_list(context, initialize_asn1_error_table_r);
 842         krb5_add_et_list(context, initialize_heim_error_table_r);
 843
 844         krb5_add_et_list(context, initialize_k524_error_table_r);
 845
 846 #ifdef COM_ERR_BINDDOMAIN_krb5
 847         bindtextdomain(COM_ERR_BINDDOMAIN_krb5, HEIMDAL_LOCALEDIR);
 848         bindtextdomain(COM_ERR_BINDDOMAIN_asn1, HEIMDAL_LOCALEDIR);
 849         bindtextdomain(COM_ERR_BINDDOMAIN_heim, HEIMDAL_LOCALEDIR);
 850         bindtextdomain(COM_ERR_BINDDOMAIN_k524, HEIMDAL_LOCALEDIR);
 851 #endif
 852
 853 #ifdef PKINIT
 854         krb5_add_et_list(context, initialize_hx_error_table_r);
 855 #ifdef COM_ERR_BINDDOMAIN_hx
 856         bindtextdomain(COM_ERR_BINDDOMAIN_hx, HEIMDAL_LOCALEDIR);
 857 #endif
 858 #endif
 859     }
 860 }
 861
 862 /**
 863  * Make the kerberos library default to the admin KDC.
 864  *
 865  * @param context Kerberos 5 context.
 866  * @param flag boolean flag to select if the use the admin KDC or not.
 867  *
 868  * @ingroup krb5
 869  */
 870
 871 void KRB5_LIB_FUNCTION
 872 krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)
 873 {
 874     context->use_admin_kdc = flag;
 875 }
 876
 877 /**
 878  * Make the kerberos library default to the admin KDC.
 879  *
 880  * @param context Kerberos 5 context.
 881  *
 882  * @return boolean flag to telling the context will use admin KDC as the default KDC.
 883  *
 884  * @ingroup krb5
 885  */
 886
 887 krb5_boolean KRB5_LIB_FUNCTION
 888 krb5_get_use_admin_kdc (krb5_context context)
 889 {
 890     return context->use_admin_kdc;
 891 }
 892
 893 /**
 894  * Add extra address to the address list that the library will add to
 895  * the client's address list when communicating with the KDC.
 896  *
 897  * @param context Kerberos 5 context.
 898  * @param addresses addreses to add
 899  *
 900  * @return Returns 0 to indicate success. Otherwise an kerberos et
 901  * error code is returned, see krb5_get_error_message().
 902  *
 903  * @ingroup krb5
 904  */
 905
 906 krb5_error_code KRB5_LIB_FUNCTION
 907 krb5_add_extra_addresses(krb5_context context, krb5_addresses *addresses)
 908 {
 909
 910     if(context->extra_addresses)
 911         return krb5_append_addresses(context,
 912                                      context->extra_addresses, addresses);
 913     else
 914         return krb5_set_extra_addresses(context, addresses);
 915 }
 916
 917 /**
 918  * Set extra address to the address list that the library will add to
 919  * the client's address list when communicating with the KDC.
 920  *
 921  * @param context Kerberos 5 context.
 922  * @param addresses addreses to set
 923  *
 924  * @return Returns 0 to indicate success. Otherwise an kerberos et
 925  * error code is returned, see krb5_get_error_message().
 926  *
 927  * @ingroup krb5
 928  */
 929
 930 krb5_error_code KRB5_LIB_FUNCTION
 931 krb5_set_extra_addresses(krb5_context context, const krb5_addresses *addresses)
 932 {
 933     if(context->extra_addresses)
 934         krb5_free_addresses(context, context->extra_addresses);
 935
 936     if(addresses == NULL) {
 937         if(context->extra_addresses != NULL) {
 938             free(context->extra_addresses);
 939             context->extra_addresses = NULL;
 940         }
 941         return 0;
 942     }
 943     if(context->extra_addresses == NULL) {
 944         context->extra_addresses = malloc(sizeof(*context->extra_addresses));
 945         if(context->extra_addresses == NULL) {
 946             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
 947             return ENOMEM;
 948         }
 949     }
 950     return krb5_copy_addresses(context, addresses, context->extra_addresses);
 951 }
 952
 953 /**
 954  * Get extra address to the address list that the library will add to
 955  * the client's address list when communicating with the KDC.
 956  *
 957  * @param context Kerberos 5 context.
 958  * @param addresses addreses to set
 959  *
 960  * @return Returns 0 to indicate success. Otherwise an kerberos et
 961  * error code is returned, see krb5_get_error_message().
 962  *
 963  * @ingroup krb5
 964  */
 965
 966 krb5_error_code KRB5_LIB_FUNCTION
 967 krb5_get_extra_addresses(krb5_context context, krb5_addresses *addresses)
 968 {
 969     if(context->extra_addresses == NULL) {
 970         memset(addresses, 0, sizeof(*addresses));
 971         return 0;
 972     }
 973     return krb5_copy_addresses(context,context->extra_addresses, addresses);
 974 }
 975
 976 /**
 977  * Add extra addresses to ignore when fetching addresses from the
 978  * underlaying operating system.
 979  *
 980  * @param context Kerberos 5 context.
 981  * @param addresses addreses to ignore
 982  *
 983  * @return Returns 0 to indicate success. Otherwise an kerberos et
 984  * error code is returned, see krb5_get_error_message().
 985  *
 986  * @ingroup krb5
 987  */
 988
 989 krb5_error_code KRB5_LIB_FUNCTION
 990 krb5_add_ignore_addresses(krb5_context context, krb5_addresses *addresses)
 991 {
 992
 993     if(context->ignore_addresses)
 994         return krb5_append_addresses(context,
 995                                      context->ignore_addresses, addresses);
 996     else
 997         return krb5_set_ignore_addresses(context, addresses);
 998 }
 999
1000 /**
1001  * Set extra addresses to ignore when fetching addresses from the
1002  * underlaying operating system.
1003  *
1004  * @param context Kerberos 5 context.
1005  * @param addresses addreses to ignore
1006  *
1007  * @return Returns 0 to indicate success. Otherwise an kerberos et
1008  * error code is returned, see krb5_get_error_message().
1009  *
1010  * @ingroup krb5
1011  */
1012
1013 krb5_error_code KRB5_LIB_FUNCTION
1014 krb5_set_ignore_addresses(krb5_context context, const krb5_addresses *addresses)
1015 {
1016     if(context->ignore_addresses)
1017         krb5_free_addresses(context, context->ignore_addresses);
1018     if(addresses == NULL) {
1019         if(context->ignore_addresses != NULL) {
1020             free(context->ignore_addresses);
1021             context->ignore_addresses = NULL;
1022         }
1023         return 0;
1024     }
1025     if(context->ignore_addresses == NULL) {
1026         context->ignore_addresses = malloc(sizeof(*context->ignore_addresses));
1027         if(context->ignore_addresses == NULL) {
1028             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
1029             return ENOMEM;
1030         }
1031     }
1032     return krb5_copy_addresses(context, addresses, context->ignore_addresses);
1033 }
1034
1035 /**
1036  * Get extra addresses to ignore when fetching addresses from the
1037  * underlaying operating system.
1038  *
1039  * @param context Kerberos 5 context.
1040  * @param addresses list addreses ignored
1041  *
1042  * @return Returns 0 to indicate success. Otherwise an kerberos et
1043  * error code is returned, see krb5_get_error_message().
1044  *
1045  * @ingroup krb5
1046  */
1047
1048 krb5_error_code KRB5_LIB_FUNCTION
1049 krb5_get_ignore_addresses(krb5_context context, krb5_addresses *addresses)
1050 {
1051     if(context->ignore_addresses == NULL) {
1052         memset(addresses, 0, sizeof(*addresses));
1053         return 0;
1054     }
1055     return krb5_copy_addresses(context, context->ignore_addresses, addresses);
1056 }
1057
1058 /**
1059  * Set version of fcache that the library should use.
1060  *
1061  * @param context Kerberos 5 context.
1062  * @param version version number.
1063  *
1064  * @return Returns 0 to indicate success. Otherwise an kerberos et
1065  * error code is returned, see krb5_get_error_message().
1066  *
1067  * @ingroup krb5
1068  */
1069
1070 krb5_error_code KRB5_LIB_FUNCTION
1071 krb5_set_fcache_version(krb5_context context, int version)
1072 {
1073     context->fcache_vno = version;
1074     return 0;
1075 }
1076
1077 /**
1078  * Get version of fcache that the library should use.
1079  *
1080  * @param context Kerberos 5 context.
1081  * @param version version number.
1082  *
1083  * @return Returns 0 to indicate success. Otherwise an kerberos et
1084  * error code is returned, see krb5_get_error_message().
1085  *
1086  * @ingroup krb5
1087  */
1088
1089 krb5_error_code KRB5_LIB_FUNCTION
1090 krb5_get_fcache_version(krb5_context context, int *version)
1091 {
1092     *version = context->fcache_vno;
1093     return 0;
1094 }
1095
1096 /**
1097  * Runtime check if the Kerberos library was complied with thread support.
1098  *
1099  * @return TRUE if the library was compiled with thread support, FALSE if not.
1100  *
1101  * @ingroup krb5
1102  */
1103
1104
1105 krb5_boolean KRB5_LIB_FUNCTION
1106 krb5_is_thread_safe(void)
1107 {
1108 #ifdef ENABLE_PTHREAD_SUPPORT
1109     return TRUE;
1110 #else
1111     return FALSE;
1112 #endif
1113 }
1114
1115 /**
1116  * Set if the library should use DNS to canonicalize hostnames.
1117  *
1118  * @param context Kerberos 5 context.
1119  * @param flag if its dns canonicalizion is used or not.
1120  *
1121  * @ingroup krb5
1122  */
1123
1124 void KRB5_LIB_FUNCTION
1125 krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)
1126 {
1127     if (flag)
1128         context->flags |= KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
1129     else
1130         context->flags &= ~KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
1131 }
1132
1133 /**
1134  * Get if the library uses DNS to canonicalize hostnames.
1135  *
1136  * @param context Kerberos 5 context.
1137  *
1138  * @return return non zero if the library uses DNS to canonicalize hostnames.
1139  *
1140  * @ingroup krb5
1141  */
1142
1143 krb5_boolean KRB5_LIB_FUNCTION
1144 krb5_get_dns_canonicalize_hostname (krb5_context context)
1145 {
1146     return (context->flags & KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME) ? 1 : 0;
1147 }
1148
1149 /**
1150  * Get current offset in time to the KDC.
1151  *
1152  * @param context Kerberos 5 context.
1153  * @param sec seconds part of offset.
1154  * @param usec micro seconds part of offset.
1155  *
1156  * @return returns zero
1157  *
1158  * @ingroup krb5
1159  */
1160
1161 krb5_error_code KRB5_LIB_FUNCTION
1162 krb5_get_kdc_sec_offset (krb5_context context, int32_t *sec, int32_t *usec)
1163 {
1164     if (sec)
1165         *sec = context->kdc_sec_offset;
1166     if (usec)
1167         *usec = context->kdc_usec_offset;
1168     return 0;
1169 }
1170
1171 /**
1172  * Set current offset in time to the KDC.
1173  *
1174  * @param context Kerberos 5 context.
1175  * @param sec seconds part of offset.
1176  * @param usec micro seconds part of offset.
1177  *
1178  * @return returns zero
1179  *
1180  * @ingroup krb5
1181  */
1182
1183 krb5_error_code KRB5_LIB_FUNCTION
1184 krb5_set_kdc_sec_offset (krb5_context context, int32_t sec, int32_t usec)
1185 {
1186     context->kdc_sec_offset = sec;
1187     if (usec >= 0)
1188         context->kdc_usec_offset = usec;
1189     return 0;
1190 }
1191
1192 /**
1193  * Get max time skew allowed.
1194  *
1195  * @param context Kerberos 5 context.
1196  *
1197  * @return timeskew in seconds.
1198  *
1199  * @ingroup krb5
1200  */
1201
1202 time_t KRB5_LIB_FUNCTION
1203 krb5_get_max_time_skew (krb5_context context)
1204 {
1205     return context->max_skew;
1206 }
1207
1208 /**
1209  * Set max time skew allowed.
1210  *
1211  * @param context Kerberos 5 context.
1212  * @param t timeskew in seconds.
1213  *
1214  * @ingroup krb5
1215  */
1216
1217 void KRB5_LIB_FUNCTION
1218 krb5_set_max_time_skew (krb5_context context, time_t t)
1219 {
1220     context->max_skew = t;
1221 }
1222
1223 /**
1224  * Init encryption types in len, val with etypes.
1225  *
1226  * @param context Kerberos 5 context.
1227  * @param len output length of val.
1228  * @param val output array of enctypes.
1229  * @param etypes etypes to set val and len to, if NULL, use default enctypes.
1230
1231  * @return Returns 0 to indicate success. Otherwise an kerberos et
1232  * error code is returned, see krb5_get_error_message().
1233  *
1234  * @ingroup krb5
1235  */
1236
1237 krb5_error_code KRB5_LIB_FUNCTION
1238 krb5_init_etype (krb5_context context,
1239                  unsigned *len,
1240                  krb5_enctype **val,
1241                  const krb5_enctype *etypes)
1242 {
1243     unsigned int i;
1244     krb5_error_code ret;
1245     krb5_enctype *tmp = NULL;
1246
1247     ret = 0;
1248     if (etypes == NULL) {
1249         ret = krb5_get_default_in_tkt_etypes(context, &tmp);
1250         if (ret)
1251             return ret;
1252         etypes = tmp;
1253     }
1254
1255     for (i = 0; etypes[i]; ++i)
1256         ;
1257     *len = i;
1258     *val = malloc(i * sizeof(**val));
1259     if (i != 0 && *val == NULL) {
1260         ret = ENOMEM;
1261         krb5_set_error_message(context, ret, N_("malloc: out of memory", ""));
1262         goto cleanup;
1263     }
1264     memmove (*val,
1265              etypes,
1266              i * sizeof(*tmp));
1267 cleanup:
1268     if (tmp != NULL)
1269         free (tmp);
1270     return ret;
1271 }
1272
1273 /*
1274  * Allow homedir accces
1275  */
1276
1277 static HEIMDAL_MUTEX homedir_mutex = HEIMDAL_MUTEX_INITIALIZER;
1278 static krb5_boolean allow_homedir = TRUE;
1279
1280 krb5_boolean
1281 _krb5_homedir_access(krb5_context context)
1282 {
1283     krb5_boolean allow;
1284
1285     /* is never allowed for root */
1286     if (geteuid() == 0)
1287         return FALSE;
1288
1289     if (context && (context->flags & KRB5_CTX_F_HOMEDIR_ACCESS) == 0)
1290         return FALSE;
1291
1292     HEIMDAL_MUTEX_lock(&homedir_mutex);
1293     allow = allow_homedir;
1294     HEIMDAL_MUTEX_unlock(&homedir_mutex);
1295     return allow;
1296 }
1297
1298 /**
1299  * Enable and disable home directory access on either the global state
1300  * or the krb5_context state. By calling krb5_set_home_dir_access()
1301  * with context set to NULL, the global state is configured otherwise
1302  * the state for the krb5_context is modified.
1303  *
1304  * For home directory access to be allowed, both the global state and
1305  * the krb5_context state have to be allowed.
1306  *
1307  * Administrator (root user), never uses the home directory.
1308  *
1309  * @param context a Kerberos 5 context or NULL
1310  * @param allow allow if TRUE home directory
1311  * @return the old value
1312  *
1313  */
1314
1315 krb5_boolean
1316 krb5_set_home_dir_access(krb5_context context, krb5_boolean allow)
1317 {
1318     krb5_boolean old;
1319     if (context) {
1320         old = (context->flags & KRB5_CTX_F_HOMEDIR_ACCESS) ? TRUE : FALSE;
1321         if (allow)
1322             context->flags |= KRB5_CTX_F_HOMEDIR_ACCESS;
1323         else
1324             context->flags &= ~KRB5_CTX_F_HOMEDIR_ACCESS;
1325     } else {
1326         HEIMDAL_MUTEX_lock(&homedir_mutex);
1327         old = allow_homedir;
1328         allow_homedir = allow;
1329         HEIMDAL_MUTEX_unlock(&homedir_mutex);
1330     }
1331
1332     return old;
1333 }