s4:heimdal: import lorikeet-heimdal-200909210500 (commit 290db8d23647a27c39b97c189a0b...
[amitay/samba.git] / 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 out:
308     if(ret) {
309         krb5_free_context(p);
310         p = NULL;
311     }
312     *context = p;
313     return ret;
314 }
315
316 #ifndef HEIMDAL_SMALLER
317
318 /*
319  *
320  */
321
322 static krb5_error_code
323 copy_etypes (krb5_context context,
324              krb5_enctype *enctypes,
325              krb5_enctype **ret_enctypes)
326 {
327     unsigned int i;
328
329     for (i = 0; enctypes[i]; i++)
330         ;
331     i++;
332
333     *ret_enctypes = malloc(sizeof(ret_enctypes[0]) * i);
334     if (*ret_enctypes == NULL) {
335         krb5_set_error_message(context, ENOMEM, 
336                                N_("malloc: out of memory", ""));
337         return ENOMEM;
338     }
339     memcpy(*ret_enctypes, enctypes, sizeof(ret_enctypes[0]) * i);
340     return 0;
341 }
342
343 /**
344  * Make a copy for the Kerberos 5 context, the new krb5_context shoud
345  * be freed with krb5_free_context().
346  *
347  * @param context the Kerberos context to copy
348  * @param out the copy of the Kerberos, set to NULL error.
349  *
350  * @return Returns 0 to indicate success.  Otherwise an kerberos et
351  * error code is returned, see krb5_get_error_message().
352  *
353  * @ingroup krb5
354  */
355
356 krb5_error_code KRB5_LIB_FUNCTION
357 krb5_copy_context(krb5_context context, krb5_context *out)
358 {
359     krb5_error_code ret;
360     krb5_context p;
361
362     *out = NULL;
363
364     p = calloc(1, sizeof(*p));
365     if (p == NULL) {
366         krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
367         return ENOMEM;
368     }
369
370     p->mutex = malloc(sizeof(HEIMDAL_MUTEX));
371     if (p->mutex == NULL) {
372         krb5_set_error_message(context, ENOMEM, N_("malloc: out of memory", ""));
373         free(p);
374         return ENOMEM;
375     }
376     HEIMDAL_MUTEX_init(p->mutex);
377
378
379     if (context->default_cc_name)
380         p->default_cc_name = strdup(context->default_cc_name);
381     if (context->default_cc_name_env)
382         p->default_cc_name_env = strdup(context->default_cc_name_env);
383     
384     if (context->etypes) {
385         ret = copy_etypes(context, context->etypes, &p->etypes);
386         if (ret)
387             goto out;
388     }
389     if (context->etypes_des) {
390         ret = copy_etypes(context, context->etypes_des, &p->etypes_des);
391         if (ret)
392             goto out;
393     }
394
395     if (context->default_realms) {
396         ret = krb5_copy_host_realm(context, 
397                                    context->default_realms, &p->default_realms);
398         if (ret)
399             goto out;
400     }
401
402     ret = _krb5_config_copy(context, context->cf, &p->cf);
403     if (ret)
404         goto out;
405
406     /* XXX should copy */
407     krb5_init_ets(p);
408     cc_ops_register(p);
409     kt_ops_register(p);
410
411 #if 0 /* XXX */
412     if(context->warn_dest != NULL)
413         ;
414     if(context->debug_dest != NULL)
415         ;
416 #endif
417
418     ret = krb5_set_extra_addresses(p, context->extra_addresses);
419     if (ret)
420         goto out;
421     ret = krb5_set_extra_addresses(p, context->ignore_addresses);
422     if (ret)
423         goto out;
424
425     ret = _krb5_copy_send_to_kdc_func(p, context);
426     if (ret)
427         goto out;
428
429     *out = p;
430
431     return 0;
432
433  out:
434     krb5_free_context(p);
435     return ret;
436 }
437
438 #endif
439
440 /**
441  * Frees the krb5_context allocated by krb5_init_context().
442  *
443  * @param context context to be freed.
444  *
445  * @ingroup krb5
446  */
447
448 void KRB5_LIB_FUNCTION
449 krb5_free_context(krb5_context context)
450 {
451     if (context->default_cc_name)
452         free(context->default_cc_name);
453     if (context->default_cc_name_env)
454         free(context->default_cc_name_env);
455     free(context->etypes);
456     free(context->etypes_des);
457     krb5_free_host_realm (context, context->default_realms);
458     krb5_config_file_free (context, context->cf);
459     free_error_table (context->et_list);
460     free(context->cc_ops);
461     free(context->kt_types);
462     krb5_clear_error_message(context);
463     if(context->warn_dest != NULL)
464         krb5_closelog(context, context->warn_dest);
465     if(context->debug_dest != NULL)
466         krb5_closelog(context, context->debug_dest);
467     krb5_set_extra_addresses(context, NULL);
468     krb5_set_ignore_addresses(context, NULL);
469     krb5_set_send_to_kdc_func(context, NULL, NULL);
470
471     HEIMDAL_MUTEX_destroy(context->mutex);
472     free(context->mutex);
473
474     memset(context, 0, sizeof(*context));
475     free(context);
476 }
477
478 /**
479  * Reinit the context from a new set of filenames.
480  *
481  * @param context context to add configuration too.
482  * @param filenames array of filenames, end of list is indicated with a NULL filename.
483  *
484  * @return Returns 0 to indicate success.  Otherwise an kerberos et
485  * error code is returned, see krb5_get_error_message().
486  *
487  * @ingroup krb5
488  */
489
490 krb5_error_code KRB5_LIB_FUNCTION
491 krb5_set_config_files(krb5_context context, char **filenames)
492 {
493     krb5_error_code ret;
494     krb5_config_binding *tmp = NULL;
495     while(filenames != NULL && *filenames != NULL && **filenames != '\0') {
496         ret = krb5_config_parse_file_multi(context, *filenames, &tmp);
497         if(ret != 0 && ret != ENOENT && ret != EACCES) {
498             krb5_config_file_free(context, tmp);
499             return ret;
500         }
501         filenames++;
502     }
503 #if 0
504     /* with this enabled and if there are no config files, Kerberos is
505        considererd disabled */
506     if(tmp == NULL)
507         return ENXIO;
508 #endif
509     krb5_config_file_free(context, context->cf);
510     context->cf = tmp;
511     ret = init_context_from_config_file(context);
512     return ret;
513 }
514
515 static krb5_error_code
516 add_file(char ***pfilenames, int *len, char *file)
517 {
518     char **pp = *pfilenames;
519     int i;
520
521     for(i = 0; i < *len; i++) {
522         if(strcmp(pp[i], file) == 0) {
523             free(file);
524             return 0;
525         }
526     }
527
528     pp = realloc(*pfilenames, (*len + 2) * sizeof(*pp));
529     if (pp == NULL) {
530         free(file);
531         return ENOMEM;
532     }
533
534     pp[*len] = file;
535     pp[*len + 1] = NULL;
536     *pfilenames = pp;
537     *len += 1;
538     return 0;
539 }
540
541 /*
542  *  `pq' isn't free, it's up the the caller
543  */
544
545 krb5_error_code KRB5_LIB_FUNCTION
546 krb5_prepend_config_files(const char *filelist, char **pq, char ***ret_pp)
547 {
548     krb5_error_code ret;
549     const char *p, *q;
550     char **pp;
551     int len;
552     char *fn;
553
554     pp = NULL;
555
556     len = 0;
557     p = filelist;
558     while(1) {
559         ssize_t l;
560         q = p;
561         l = strsep_copy(&q, ":", NULL, 0);
562         if(l == -1)
563             break;
564         fn = malloc(l + 1);
565         if(fn == NULL) {
566             krb5_free_config_files(pp);
567             return ENOMEM;
568         }
569         (void)strsep_copy(&p, ":", fn, l + 1);
570         ret = add_file(&pp, &len, fn);
571         if (ret) {
572             krb5_free_config_files(pp);
573             return ret;
574         }
575     }
576
577     if (pq != NULL) {
578         int i;
579
580         for (i = 0; pq[i] != NULL; i++) {
581             fn = strdup(pq[i]);
582             if (fn == NULL) {
583                 krb5_free_config_files(pp);
584                 return ENOMEM;
585             }
586             ret = add_file(&pp, &len, fn);
587             if (ret) {
588                 krb5_free_config_files(pp);
589                 return ret;
590             }
591         }
592     }
593
594     *ret_pp = pp;
595     return 0;
596 }
597
598 /**
599  * Prepend the filename to the global configuration list.
600  *
601  * @param filelist a filename to add to the default list of filename
602  * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
603  *
604  * @return Returns 0 to indicate success.  Otherwise an kerberos et
605  * error code is returned, see krb5_get_error_message().
606  *
607  * @ingroup krb5
608  */
609
610 krb5_error_code KRB5_LIB_FUNCTION
611 krb5_prepend_config_files_default(const char *filelist, char ***pfilenames)
612 {
613     krb5_error_code ret;
614     char **defpp, **pp = NULL;
615
616     ret = krb5_get_default_config_files(&defpp);
617     if (ret)
618         return ret;
619
620     ret = krb5_prepend_config_files(filelist, defpp, &pp);
621     krb5_free_config_files(defpp);
622     if (ret) {
623         return ret;
624     }   
625     *pfilenames = pp;
626     return 0;
627 }
628
629 /**
630  * Get the global configuration list.
631  *
632  * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
633  *
634  * @return Returns 0 to indicate success.  Otherwise an kerberos et
635  * error code is returned, see krb5_get_error_message().
636  *
637  * @ingroup krb5
638  */
639
640 krb5_error_code KRB5_LIB_FUNCTION
641 krb5_get_default_config_files(char ***pfilenames)
642 {
643     const char *files = NULL;
644
645     if (pfilenames == NULL)
646         return EINVAL;
647     if(!issuid())
648         files = getenv("KRB5_CONFIG");
649     if (files == NULL)
650         files = krb5_config_file;
651
652     return krb5_prepend_config_files(files, NULL, pfilenames);
653 }
654
655 /**
656  * Free a list of configuration files.
657  *
658  * @param filenames list, terminated with a NULL pointer, to be
659  * freed. NULL is an valid argument.
660  *
661  * @return Returns 0 to indicate success. Otherwise an kerberos et
662  * error code is returned, see krb5_get_error_message().
663  *
664  * @ingroup krb5
665  */
666
667 void KRB5_LIB_FUNCTION
668 krb5_free_config_files(char **filenames)
669 {
670     char **p;
671     for(p = filenames; p && *p != NULL; p++)
672         free(*p);
673     free(filenames);
674 }
675
676 /**
677  * Returns the list of Kerberos encryption types sorted in order of
678  * most preferred to least preferred encryption type.  Note that some
679  * encryption types might be disabled, so you need to check with
680  * krb5_enctype_valid() before using the encryption type.
681  *
682  * @return list of enctypes, terminated with ETYPE_NULL. Its a static
683  * array completed into the Kerberos library so the content doesn't
684  * need to be freed.
685  *
686  * @ingroup krb5
687  */
688
689 const krb5_enctype * KRB5_LIB_FUNCTION
690 krb5_kerberos_enctypes(krb5_context context)
691 {
692     static const krb5_enctype p[] = {
693         ETYPE_AES256_CTS_HMAC_SHA1_96,
694         ETYPE_AES128_CTS_HMAC_SHA1_96,
695         ETYPE_DES3_CBC_SHA1,
696         ETYPE_DES3_CBC_MD5,
697         ETYPE_ARCFOUR_HMAC_MD5,
698         ETYPE_DES_CBC_MD5,
699         ETYPE_DES_CBC_MD4,
700         ETYPE_DES_CBC_CRC,
701         ETYPE_NULL
702     };
703     return p;
704 }
705
706 /*
707  * set `etype' to a malloced list of the default enctypes
708  */
709
710 static krb5_error_code
711 default_etypes(krb5_context context, krb5_enctype **etype)
712 {
713     const krb5_enctype *p;
714     krb5_enctype *e = NULL, *ep;
715     int i, n = 0;
716
717     p = krb5_kerberos_enctypes(context);
718
719     for (i = 0; p[i] != ETYPE_NULL; i++) {
720         if (krb5_enctype_valid(context, p[i]) != 0)
721             continue;
722         ep = realloc(e, (n + 2) * sizeof(*e));
723         if (ep == NULL) {
724             free(e);
725             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
726             return ENOMEM;
727         }
728         e = ep;
729         e[n] = p[i];
730         e[n + 1] = ETYPE_NULL;
731         n++;
732     }
733     *etype = e;
734     return 0;
735 }
736
737 /**
738  * Set the default encryption types that will be use in communcation
739  * with the KDC, clients and servers.
740  *
741  * @param context Kerberos 5 context.
742  * @param etypes Encryption types, array terminated with ETYPE_NULL (0).
743  *
744  * @return Returns 0 to indicate success. Otherwise an kerberos et
745  * error code is returned, see krb5_get_error_message().
746  *
747  * @ingroup krb5
748  */
749
750 krb5_error_code KRB5_LIB_FUNCTION
751 krb5_set_default_in_tkt_etypes(krb5_context context,
752                                const krb5_enctype *etypes)
753 {
754     krb5_enctype *p = NULL;
755     int i;
756
757     if(etypes) {
758         for (i = 0; etypes[i]; ++i) {
759             krb5_error_code ret;
760             ret = krb5_enctype_valid(context, etypes[i]);
761             if (ret)
762                 return ret;
763         }
764         ++i;
765         ALLOC(p, i);
766         if(!p) {
767             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
768             return ENOMEM;
769         }
770         memmove(p, etypes, i * sizeof(krb5_enctype));
771     }
772     if(context->etypes)
773         free(context->etypes);
774     context->etypes = p;
775     return 0;
776 }
777
778 /**
779  * Get the default encryption types that will be use in communcation
780  * with the KDC, clients and servers.
781  *
782  * @param context Kerberos 5 context.
783  * @param etypes Encryption types, array terminated with
784  * ETYPE_NULL(0), caller should free array with krb5_xfree():
785  *
786  * @return Returns 0 to indicate success. Otherwise an kerberos et
787  * error code is returned, see krb5_get_error_message().
788  *
789  * @ingroup krb5
790  */
791
792 krb5_error_code KRB5_LIB_FUNCTION
793 krb5_get_default_in_tkt_etypes(krb5_context context,
794                                krb5_enctype **etypes)
795 {
796     krb5_enctype *p;
797     int i;
798     krb5_error_code ret;
799
800     if(context->etypes) {
801         for(i = 0; context->etypes[i]; i++);
802         ++i;
803         ALLOC(p, i);
804         if(!p) {
805             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
806             return ENOMEM;
807         }
808         memmove(p, context->etypes, i * sizeof(krb5_enctype));
809     } else {
810         ret = default_etypes(context, &p);
811         if (ret)
812             return ret;
813     }
814     *etypes = p;
815     return 0;
816 }
817
818 /**
819  * Return the error string for the error code. The caller must not
820  * free the string.
821  *
822  * @param context Kerberos 5 context.
823  * @param code Kerberos error code.
824  *
825  * @return the error message matching code
826  *
827  * @ingroup krb5
828  */
829
830 const char* KRB5_LIB_FUNCTION
831 krb5_get_err_text(krb5_context context, krb5_error_code code)
832 {
833     const char *p = NULL;
834     if(context != NULL)
835         p = com_right(context->et_list, code);
836     if(p == NULL)
837         p = strerror(code);
838     if (p == NULL)
839         p = "Unknown error";
840     return p;
841 }
842
843 /**
844  * Init the built-in ets in the Kerberos library.
845  *
846  * @param context kerberos context to add the ets too
847  *
848  * @ingroup krb5
849  */
850
851 void KRB5_LIB_FUNCTION
852 krb5_init_ets(krb5_context context)
853 {
854     if(context->et_list == NULL){
855         krb5_add_et_list(context, initialize_krb5_error_table_r);
856         krb5_add_et_list(context, initialize_asn1_error_table_r);
857         krb5_add_et_list(context, initialize_heim_error_table_r);
858
859         krb5_add_et_list(context, initialize_k524_error_table_r);
860
861 #ifdef COM_ERR_BINDDOMAIN_krb5
862         bindtextdomain(COM_ERR_BINDDOMAIN_krb5, HEIMDAL_LOCALEDIR);
863         bindtextdomain(COM_ERR_BINDDOMAIN_asn1, HEIMDAL_LOCALEDIR);
864         bindtextdomain(COM_ERR_BINDDOMAIN_heim, HEIMDAL_LOCALEDIR);
865         bindtextdomain(COM_ERR_BINDDOMAIN_k524, HEIMDAL_LOCALEDIR);
866 #endif
867
868 #ifdef PKINIT
869         krb5_add_et_list(context, initialize_hx_error_table_r);
870 #ifdef COM_ERR_BINDDOMAIN_hx
871         bindtextdomain(COM_ERR_BINDDOMAIN_hx, HEIMDAL_LOCALEDIR);
872 #endif
873 #endif
874     }
875 }
876
877 /**
878  * Make the kerberos library default to the admin KDC.
879  *
880  * @param context Kerberos 5 context.
881  * @param flag boolean flag to select if the use the admin KDC or not.
882  *
883  * @ingroup krb5
884  */
885
886 void KRB5_LIB_FUNCTION
887 krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)
888 {
889     context->use_admin_kdc = flag;
890 }
891
892 /**
893  * Make the kerberos library default to the admin KDC.
894  *
895  * @param context Kerberos 5 context.
896  *
897  * @return boolean flag to telling the context will use admin KDC as the default KDC.
898  *
899  * @ingroup krb5
900  */
901
902 krb5_boolean KRB5_LIB_FUNCTION
903 krb5_get_use_admin_kdc (krb5_context context)
904 {
905     return context->use_admin_kdc;
906 }
907
908 /**
909  * Add extra address to the address list that the library will add to
910  * the client's address list when communicating with the KDC.
911  *
912  * @param context Kerberos 5 context.
913  * @param addresses addreses to add
914  *
915  * @return Returns 0 to indicate success. Otherwise an kerberos et
916  * error code is returned, see krb5_get_error_message().
917  *
918  * @ingroup krb5
919  */
920
921 krb5_error_code KRB5_LIB_FUNCTION
922 krb5_add_extra_addresses(krb5_context context, krb5_addresses *addresses)
923 {
924
925     if(context->extra_addresses)
926         return krb5_append_addresses(context,
927                                      context->extra_addresses, addresses);
928     else
929         return krb5_set_extra_addresses(context, addresses);
930 }
931
932 /**
933  * Set extra address to the address list that the library will add to
934  * the client's address list when communicating with the KDC.
935  *
936  * @param context Kerberos 5 context.
937  * @param addresses addreses to set
938  *
939  * @return Returns 0 to indicate success. Otherwise an kerberos et
940  * error code is returned, see krb5_get_error_message().
941  *
942  * @ingroup krb5
943  */
944
945 krb5_error_code KRB5_LIB_FUNCTION
946 krb5_set_extra_addresses(krb5_context context, const krb5_addresses *addresses)
947 {
948     if(context->extra_addresses)
949         krb5_free_addresses(context, context->extra_addresses);
950
951     if(addresses == NULL) {
952         if(context->extra_addresses != NULL) {
953             free(context->extra_addresses);
954             context->extra_addresses = NULL;
955         }
956         return 0;
957     }
958     if(context->extra_addresses == NULL) {
959         context->extra_addresses = malloc(sizeof(*context->extra_addresses));
960         if(context->extra_addresses == NULL) {
961             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
962             return ENOMEM;
963         }
964     }
965     return krb5_copy_addresses(context, addresses, context->extra_addresses);
966 }
967
968 /**
969  * Get extra address to the address list that the library will add to
970  * the client's address list when communicating with the KDC.
971  *
972  * @param context Kerberos 5 context.
973  * @param addresses addreses to set
974  *
975  * @return Returns 0 to indicate success. Otherwise an kerberos et
976  * error code is returned, see krb5_get_error_message().
977  *
978  * @ingroup krb5
979  */
980
981 krb5_error_code KRB5_LIB_FUNCTION
982 krb5_get_extra_addresses(krb5_context context, krb5_addresses *addresses)
983 {
984     if(context->extra_addresses == NULL) {
985         memset(addresses, 0, sizeof(*addresses));
986         return 0;
987     }
988     return krb5_copy_addresses(context,context->extra_addresses, addresses);
989 }
990
991 /**
992  * Add extra addresses to ignore when fetching addresses from the
993  * underlaying operating system.
994  *
995  * @param context Kerberos 5 context.
996  * @param addresses addreses to ignore
997  *
998  * @return Returns 0 to indicate success. Otherwise an kerberos et
999  * error code is returned, see krb5_get_error_message().
1000  *
1001  * @ingroup krb5
1002  */
1003
1004 krb5_error_code KRB5_LIB_FUNCTION
1005 krb5_add_ignore_addresses(krb5_context context, krb5_addresses *addresses)
1006 {
1007
1008     if(context->ignore_addresses)
1009         return krb5_append_addresses(context,
1010                                      context->ignore_addresses, addresses);
1011     else
1012         return krb5_set_ignore_addresses(context, addresses);
1013 }
1014
1015 /**
1016  * Set extra addresses to ignore when fetching addresses from the
1017  * underlaying operating system.
1018  *
1019  * @param context Kerberos 5 context.
1020  * @param addresses addreses to ignore
1021  *
1022  * @return Returns 0 to indicate success. Otherwise an kerberos et
1023  * error code is returned, see krb5_get_error_message().
1024  *
1025  * @ingroup krb5
1026  */
1027
1028 krb5_error_code KRB5_LIB_FUNCTION
1029 krb5_set_ignore_addresses(krb5_context context, const krb5_addresses *addresses)
1030 {
1031     if(context->ignore_addresses)
1032         krb5_free_addresses(context, context->ignore_addresses);
1033     if(addresses == NULL) {
1034         if(context->ignore_addresses != NULL) {
1035             free(context->ignore_addresses);
1036             context->ignore_addresses = NULL;
1037         }
1038         return 0;
1039     }
1040     if(context->ignore_addresses == NULL) {
1041         context->ignore_addresses = malloc(sizeof(*context->ignore_addresses));
1042         if(context->ignore_addresses == NULL) {
1043             krb5_set_error_message (context, ENOMEM, N_("malloc: out of memory", ""));
1044             return ENOMEM;
1045         }
1046     }
1047     return krb5_copy_addresses(context, addresses, context->ignore_addresses);
1048 }
1049
1050 /**
1051  * Get extra addresses to ignore when fetching addresses from the
1052  * underlaying operating system.
1053  *
1054  * @param context Kerberos 5 context.
1055  * @param addresses list addreses ignored
1056  *
1057  * @return Returns 0 to indicate success. Otherwise an kerberos et
1058  * error code is returned, see krb5_get_error_message().
1059  *
1060  * @ingroup krb5
1061  */
1062
1063 krb5_error_code KRB5_LIB_FUNCTION
1064 krb5_get_ignore_addresses(krb5_context context, krb5_addresses *addresses)
1065 {
1066     if(context->ignore_addresses == NULL) {
1067         memset(addresses, 0, sizeof(*addresses));
1068         return 0;
1069     }
1070     return krb5_copy_addresses(context, context->ignore_addresses, addresses);
1071 }
1072
1073 /**
1074  * Set version of fcache that the library should use.
1075  *
1076  * @param context Kerberos 5 context.
1077  * @param version version number.
1078  *
1079  * @return Returns 0 to indicate success. Otherwise an kerberos et
1080  * error code is returned, see krb5_get_error_message().
1081  *
1082  * @ingroup krb5
1083  */
1084
1085 krb5_error_code KRB5_LIB_FUNCTION
1086 krb5_set_fcache_version(krb5_context context, int version)
1087 {
1088     context->fcache_vno = version;
1089     return 0;
1090 }
1091
1092 /**
1093  * Get version of fcache that the library should use.
1094  *
1095  * @param context Kerberos 5 context.
1096  * @param version version number.
1097  *
1098  * @return Returns 0 to indicate success. Otherwise an kerberos et
1099  * error code is returned, see krb5_get_error_message().
1100  *
1101  * @ingroup krb5
1102  */
1103
1104 krb5_error_code KRB5_LIB_FUNCTION
1105 krb5_get_fcache_version(krb5_context context, int *version)
1106 {
1107     *version = context->fcache_vno;
1108     return 0;
1109 }
1110
1111 /**
1112  * Runtime check if the Kerberos library was complied with thread support.
1113  *
1114  * @return TRUE if the library was compiled with thread support, FALSE if not.
1115  *
1116  * @ingroup krb5
1117  */
1118
1119
1120 krb5_boolean KRB5_LIB_FUNCTION
1121 krb5_is_thread_safe(void)
1122 {
1123 #ifdef ENABLE_PTHREAD_SUPPORT
1124     return TRUE;
1125 #else
1126     return FALSE;
1127 #endif
1128 }
1129
1130 /**
1131  * Set if the library should use DNS to canonicalize hostnames.
1132  *
1133  * @param context Kerberos 5 context.
1134  * @param flag if its dns canonicalizion is used or not.
1135  *
1136  * @ingroup krb5
1137  */
1138
1139 void KRB5_LIB_FUNCTION
1140 krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)
1141 {
1142     if (flag)
1143         context->flags |= KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
1144     else
1145         context->flags &= ~KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
1146 }
1147
1148 /**
1149  * Get if the library uses DNS to canonicalize hostnames.
1150  *
1151  * @param context Kerberos 5 context.
1152  *
1153  * @return return non zero if the library uses DNS to canonicalize hostnames.
1154  *
1155  * @ingroup krb5
1156  */
1157
1158 krb5_boolean KRB5_LIB_FUNCTION
1159 krb5_get_dns_canonicalize_hostname (krb5_context context)
1160 {
1161     return (context->flags & KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME) ? 1 : 0;
1162 }
1163
1164 /**
1165  * Get current offset in time to the KDC.
1166  *
1167  * @param context Kerberos 5 context.
1168  * @param sec seconds part of offset.
1169  * @param usec micro seconds part of offset.
1170  *
1171  * @return returns zero
1172  *
1173  * @ingroup krb5
1174  */
1175
1176 krb5_error_code KRB5_LIB_FUNCTION
1177 krb5_get_kdc_sec_offset (krb5_context context, int32_t *sec, int32_t *usec)
1178 {
1179     if (sec)
1180         *sec = context->kdc_sec_offset;
1181     if (usec)
1182         *usec = context->kdc_usec_offset;
1183     return 0;
1184 }
1185
1186 /**
1187  * Set current offset in time to the KDC.
1188  *
1189  * @param context Kerberos 5 context.
1190  * @param sec seconds part of offset.
1191  * @param usec micro seconds part of offset.
1192  *
1193  * @return returns zero
1194  *
1195  * @ingroup krb5
1196  */
1197
1198 krb5_error_code KRB5_LIB_FUNCTION
1199 krb5_set_kdc_sec_offset (krb5_context context, int32_t sec, int32_t usec)
1200 {
1201     context->kdc_sec_offset = sec;
1202     if (usec >= 0)
1203         context->kdc_usec_offset = usec;
1204     return 0;
1205 }
1206
1207 /**
1208  * Get max time skew allowed.
1209  *
1210  * @param context Kerberos 5 context.
1211  *
1212  * @return timeskew in seconds.
1213  *
1214  * @ingroup krb5
1215  */
1216
1217 time_t KRB5_LIB_FUNCTION
1218 krb5_get_max_time_skew (krb5_context context)
1219 {
1220     return context->max_skew;
1221 }
1222
1223 /**
1224  * Set max time skew allowed.
1225  *
1226  * @param context Kerberos 5 context.
1227  * @param t timeskew in seconds.
1228  *
1229  * @ingroup krb5
1230  */
1231
1232 void KRB5_LIB_FUNCTION
1233 krb5_set_max_time_skew (krb5_context context, time_t t)
1234 {
1235     context->max_skew = t;
1236 }
1237
1238 /**
1239  * Init encryption types in len, val with etypes.
1240  *
1241  * @param context Kerberos 5 context.
1242  * @param len output length of val.
1243  * @param val output array of enctypes.
1244  * @param etypes etypes to set val and len to, if NULL, use default enctypes.
1245
1246  * @return Returns 0 to indicate success. Otherwise an kerberos et
1247  * error code is returned, see krb5_get_error_message().
1248  *
1249  * @ingroup krb5
1250  */
1251
1252 krb5_error_code KRB5_LIB_FUNCTION
1253 krb5_init_etype (krb5_context context,
1254                  unsigned *len,
1255                  krb5_enctype **val,
1256                  const krb5_enctype *etypes)
1257 {
1258     unsigned int i;
1259     krb5_error_code ret;
1260     krb5_enctype *tmp = NULL;
1261
1262     ret = 0;
1263     if (etypes == NULL) {
1264         ret = krb5_get_default_in_tkt_etypes(context, &tmp);
1265         if (ret)
1266             return ret;
1267         etypes = tmp;
1268     }
1269
1270     for (i = 0; etypes[i]; ++i)
1271         ;
1272     *len = i;
1273     *val = malloc(i * sizeof(**val));
1274     if (i != 0 && *val == NULL) {
1275         ret = ENOMEM;
1276         krb5_set_error_message(context, ret, N_("malloc: out of memory", ""));
1277         goto cleanup;
1278     }
1279     memmove (*val,
1280              etypes,
1281              i * sizeof(*tmp));
1282 cleanup:
1283     if (tmp != NULL)
1284         free (tmp);
1285     return ret;
1286 }
1287
1288 /*
1289  * Allow homedir accces
1290  */
1291
1292 static HEIMDAL_MUTEX homedir_mutex = HEIMDAL_MUTEX_INITIALIZER;
1293 static krb5_boolean allow_homedir = TRUE;
1294
1295 krb5_boolean
1296 _krb5_homedir_access(krb5_context context)
1297 {
1298     krb5_boolean allow;
1299
1300     /* is never allowed for root */
1301     if (geteuid() == 0)
1302         return FALSE;
1303
1304     if (context && (context->flags & KRB5_CTX_F_HOMEDIR_ACCESS) == 0)
1305         return FALSE;
1306
1307     HEIMDAL_MUTEX_lock(&homedir_mutex);
1308     allow = allow_homedir;
1309     HEIMDAL_MUTEX_unlock(&homedir_mutex);
1310     return allow;
1311 }
1312
1313 /**
1314  * Enable and disable home directory access on either the global state
1315  * or the krb5_context state. By calling krb5_set_home_dir_access()
1316  * with context set to NULL, the global state is configured otherwise
1317  * the state for the krb5_context is modified.
1318  *
1319  * For home directory access to be allowed, both the global state and
1320  * the krb5_context state have to be allowed.
1321  *
1322  * Administrator (root user), never uses the home directory.
1323  *
1324  * @param context a Kerberos 5 context or NULL
1325  * @param allow allow if TRUE home directory
1326  * @return the old value
1327  *
1328  */
1329
1330 krb5_boolean
1331 krb5_set_home_dir_access(krb5_context context, krb5_boolean allow)
1332 {
1333     krb5_boolean old;
1334     if (context) {
1335         old = (context->flags & KRB5_CTX_F_HOMEDIR_ACCESS) ? TRUE : FALSE;
1336         if (allow)
1337             context->flags |= KRB5_CTX_F_HOMEDIR_ACCESS;
1338         else
1339             context->flags &= ~KRB5_CTX_F_HOMEDIR_ACCESS;
1340     } else {
1341         HEIMDAL_MUTEX_lock(&homedir_mutex);
1342         old = allow_homedir;
1343         allow_homedir = allow;
1344         HEIMDAL_MUTEX_unlock(&homedir_mutex);
1345     }
1346
1347     return old;
1348 }