Add newline to avoid generating broken krb5-protos. from David Love.
[heimdal.git] / lib / krb5 / context.c
blob1e4e6ce7d36010ac1d257690984b91884d627120
1 /*
2 * Copyright (c) 1997 - 2005 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
34 #include "krb5_locl.h"
35 #include <com_err.h>
37 RCSID("$Id$");
39 #define INIT_FIELD(C, T, E, D, F) \
40 (C)->E = krb5_config_get_ ## T ## _default ((C), NULL, (D), \
41 "libdefaults", F, NULL)
43 #define INIT_FLAG(C, O, V, D, F) \
44 do { \
45 if (krb5_config_get_bool_default((C), NULL, (D),"libdefaults", F, NULL)) { \
46 (C)->O |= V; \
47 } \
48 } while(0)
51 * Set the list of etypes `ret_etypes' from the configuration variable
52 * `name'
55 static krb5_error_code
56 set_etypes (krb5_context context,
57 const char *name,
58 krb5_enctype **ret_enctypes)
60 char **etypes_str;
61 krb5_enctype *etypes = NULL;
63 etypes_str = krb5_config_get_strings(context, NULL, "libdefaults",
64 name, NULL);
65 if(etypes_str){
66 int i, j, k;
67 for(i = 0; etypes_str[i]; i++);
68 etypes = malloc((i+1) * sizeof(*etypes));
69 if (etypes == NULL) {
70 krb5_config_free_strings (etypes_str);
71 krb5_set_error_string (context, "malloc: out of memory");
72 return ENOMEM;
74 for(j = 0, k = 0; j < i; j++) {
75 krb5_enctype e;
76 if(krb5_string_to_enctype(context, etypes_str[j], &e) != 0)
77 continue;
78 if (krb5_enctype_valid(context, e) != 0)
79 continue;
80 etypes[k++] = e;
82 etypes[k] = ETYPE_NULL;
83 krb5_config_free_strings(etypes_str);
85 *ret_enctypes = etypes;
86 return 0;
90 * read variables from the configuration file and set in `context'
93 static krb5_error_code
94 init_context_from_config_file(krb5_context context)
96 krb5_error_code ret;
97 const char * tmp;
98 krb5_enctype *tmptypes;
100 INIT_FIELD(context, time, max_skew, 5 * 60, "clockskew");
101 INIT_FIELD(context, time, kdc_timeout, 3, "kdc_timeout");
102 INIT_FIELD(context, int, max_retries, 3, "max_retries");
104 INIT_FIELD(context, string, http_proxy, NULL, "http_proxy");
106 ret = set_etypes (context, "default_etypes", &tmptypes);
107 if(ret)
108 return ret;
109 free(context->etypes);
110 context->etypes = tmptypes;
112 ret = set_etypes (context, "default_etypes_des", &tmptypes);
113 if(ret)
114 return ret;
115 free(context->etypes_des);
116 context->etypes_des = tmptypes;
118 /* default keytab name */
119 tmp = NULL;
120 if(!issuid())
121 tmp = getenv("KRB5_KTNAME");
122 if(tmp != NULL)
123 context->default_keytab = tmp;
124 else
125 INIT_FIELD(context, string, default_keytab,
126 KEYTAB_DEFAULT, "default_keytab_name");
128 INIT_FIELD(context, string, default_keytab_modify,
129 NULL, "default_keytab_modify_name");
131 INIT_FIELD(context, string, time_fmt,
132 "%Y-%m-%dT%H:%M:%S", "time_format");
134 INIT_FIELD(context, string, date_fmt,
135 "%Y-%m-%d", "date_format");
137 INIT_FIELD(context, bool, log_utc,
138 FALSE, "log_utc");
142 /* init dns-proxy slime */
143 tmp = krb5_config_get_string(context, NULL, "libdefaults",
144 "dns_proxy", NULL);
145 if(tmp)
146 roken_gethostby_setup(context->http_proxy, tmp);
147 krb5_free_host_realm (context, context->default_realms);
148 context->default_realms = NULL;
151 krb5_addresses addresses;
152 char **adr, **a;
154 krb5_set_extra_addresses(context, NULL);
155 adr = krb5_config_get_strings(context, NULL,
156 "libdefaults",
157 "extra_addresses",
158 NULL);
159 memset(&addresses, 0, sizeof(addresses));
160 for(a = adr; a && *a; a++) {
161 ret = krb5_parse_address(context, *a, &addresses);
162 if (ret == 0) {
163 krb5_add_extra_addresses(context, &addresses);
164 krb5_free_addresses(context, &addresses);
167 krb5_config_free_strings(adr);
169 krb5_set_ignore_addresses(context, NULL);
170 adr = krb5_config_get_strings(context, NULL,
171 "libdefaults",
172 "ignore_addresses",
173 NULL);
174 memset(&addresses, 0, sizeof(addresses));
175 for(a = adr; a && *a; a++) {
176 ret = krb5_parse_address(context, *a, &addresses);
177 if (ret == 0) {
178 krb5_add_ignore_addresses(context, &addresses);
179 krb5_free_addresses(context, &addresses);
182 krb5_config_free_strings(adr);
185 INIT_FIELD(context, bool, scan_interfaces, TRUE, "scan_interfaces");
186 INIT_FIELD(context, int, fcache_vno, 0, "fcache_version");
187 /* prefer dns_lookup_kdc over srv_lookup. */
188 INIT_FIELD(context, bool, srv_lookup, TRUE, "srv_lookup");
189 INIT_FIELD(context, bool, srv_lookup, context->srv_lookup, "dns_lookup_kdc");
190 INIT_FIELD(context, int, large_msg_size, 1400, "large_message_size");
191 INIT_FLAG(context, flags, KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME, TRUE, "dns_canonicalize_hostname");
192 INIT_FLAG(context, flags, KRB5_CTX_F_CHECK_PAC, TRUE, "check_pac");
193 context->default_cc_name = NULL;
194 context->default_cc_name_set = 0;
195 return 0;
199 * Initializes the context structure and reads the configuration file
200 * /etc/krb5.conf. The structure should be freed by calling
201 * krb5_free_context() when it is no longer being used.
203 * @param context pointer to returned context
205 * @return Returns 0 to indicate success. Otherwise an errno code is
206 * returned. Failure means either that something bad happened during
207 * initialization (typically ENOMEM) or that Kerberos should not be
208 * used ENXIO.
210 * @ingroup krb5
213 krb5_error_code KRB5_LIB_FUNCTION
214 krb5_init_context(krb5_context *context)
216 krb5_context p;
217 krb5_error_code ret;
218 char **files;
220 *context = NULL;
222 p = calloc(1, sizeof(*p));
223 if(!p)
224 return ENOMEM;
226 p->mutex = malloc(sizeof(HEIMDAL_MUTEX));
227 if (p->mutex == NULL) {
228 free(p);
229 return ENOMEM;
231 HEIMDAL_MUTEX_init(p->mutex);
233 ret = krb5_get_default_config_files(&files);
234 if(ret)
235 goto out;
236 ret = krb5_set_config_files(p, files);
237 krb5_free_config_files(files);
238 if(ret)
239 goto out;
241 /* init error tables */
242 krb5_init_ets(p);
244 p->cc_ops = NULL;
245 p->num_cc_ops = 0;
246 krb5_cc_register(p, &krb5_acc_ops, TRUE);
247 krb5_cc_register(p, &krb5_fcc_ops, TRUE);
248 krb5_cc_register(p, &krb5_mcc_ops, TRUE);
249 #ifdef HAVE_KCM
250 krb5_cc_register(p, &krb5_kcm_ops, TRUE);
251 #endif
253 p->num_kt_types = 0;
254 p->kt_types = NULL;
255 krb5_kt_register (p, &krb5_fkt_ops);
256 krb5_kt_register (p, &krb5_wrfkt_ops);
257 krb5_kt_register (p, &krb5_javakt_ops);
258 krb5_kt_register (p, &krb5_mkt_ops);
259 krb5_kt_register (p, &krb5_akf_ops);
260 krb5_kt_register (p, &krb4_fkt_ops);
261 krb5_kt_register (p, &krb5_srvtab_fkt_ops);
262 krb5_kt_register (p, &krb5_any_ops);
264 out:
265 if(ret) {
266 krb5_free_context(p);
267 p = NULL;
269 *context = p;
270 return ret;
274 * Frees the krb5_context allocated by krb5_init_context().
276 * @param context context to be freed.
278 * @ingroup krb5
281 void KRB5_LIB_FUNCTION
282 krb5_free_context(krb5_context context)
284 if (context->default_cc_name)
285 free(context->default_cc_name);
286 if (context->default_cc_name_env)
287 free(context->default_cc_name_env);
288 free(context->etypes);
289 free(context->etypes_des);
290 krb5_free_host_realm (context, context->default_realms);
291 krb5_config_file_free (context, context->cf);
292 free_error_table (context->et_list);
293 free(context->cc_ops);
294 free(context->kt_types);
295 krb5_clear_error_string(context);
296 if(context->warn_dest != NULL)
297 krb5_closelog(context, context->warn_dest);
298 krb5_set_extra_addresses(context, NULL);
299 krb5_set_ignore_addresses(context, NULL);
300 krb5_set_send_to_kdc_func(context, NULL, NULL);
301 if (context->mutex != NULL) {
302 HEIMDAL_MUTEX_destroy(context->mutex);
303 free(context->mutex);
305 memset(context, 0, sizeof(*context));
306 free(context);
310 * Reinit the context from a new set of filenames.
312 * @param context context to add configuration too.
313 * @param filenames array of filenames, end of list is indicated with a NULL filename.
315 * @return Returns 0 to indicate success. Otherwise an kerberos et
316 * error code is returned, see krb5_get_error_message().
318 * @ingroup krb5
321 krb5_error_code KRB5_LIB_FUNCTION
322 krb5_set_config_files(krb5_context context, char **filenames)
324 krb5_error_code ret;
325 krb5_config_binding *tmp = NULL;
326 while(filenames != NULL && *filenames != NULL && **filenames != '\0') {
327 ret = krb5_config_parse_file_multi(context, *filenames, &tmp);
328 if(ret != 0 && ret != ENOENT && ret != EACCES) {
329 krb5_config_file_free(context, tmp);
330 return ret;
332 filenames++;
334 #if 0
335 /* with this enabled and if there are no config files, Kerberos is
336 considererd disabled */
337 if(tmp == NULL)
338 return ENXIO;
339 #endif
340 krb5_config_file_free(context, context->cf);
341 context->cf = tmp;
342 ret = init_context_from_config_file(context);
343 return ret;
346 static krb5_error_code
347 add_file(char ***pfilenames, int *len, char *file)
349 char **pp = *pfilenames;
350 int i;
352 for(i = 0; i < *len; i++) {
353 if(strcmp(pp[i], file) == 0) {
354 free(file);
355 return 0;
359 pp = realloc(*pfilenames, (*len + 2) * sizeof(*pp));
360 if (pp == NULL) {
361 free(file);
362 return ENOMEM;
365 pp[*len] = file;
366 pp[*len + 1] = NULL;
367 *pfilenames = pp;
368 *len += 1;
369 return 0;
373 * `pq' isn't free, it's up the the caller
376 krb5_error_code KRB5_LIB_FUNCTION
377 krb5_prepend_config_files(const char *filelist, char **pq, char ***ret_pp)
379 krb5_error_code ret;
380 const char *p, *q;
381 char **pp;
382 int len;
383 char *fn;
385 pp = NULL;
387 len = 0;
388 p = filelist;
389 while(1) {
390 ssize_t l;
391 q = p;
392 l = strsep_copy(&q, ":", NULL, 0);
393 if(l == -1)
394 break;
395 fn = malloc(l + 1);
396 if(fn == NULL) {
397 krb5_free_config_files(pp);
398 return ENOMEM;
400 l = strsep_copy(&p, ":", fn, l + 1);
401 ret = add_file(&pp, &len, fn);
402 if (ret) {
403 krb5_free_config_files(pp);
404 return ret;
408 if (pq != NULL) {
409 int i;
411 for (i = 0; pq[i] != NULL; i++) {
412 fn = strdup(pq[i]);
413 if (fn == NULL) {
414 krb5_free_config_files(pp);
415 return ENOMEM;
417 ret = add_file(&pp, &len, fn);
418 if (ret) {
419 krb5_free_config_files(pp);
420 return ret;
425 *ret_pp = pp;
426 return 0;
430 * Prepend the filename to the global configuration list.
432 * @param filelist a filename to add to the default list of filename
433 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
435 * @return Returns 0 to indicate success. Otherwise an kerberos et
436 * error code is returned, see krb5_get_error_message().
438 * @ingroup krb5
441 krb5_error_code KRB5_LIB_FUNCTION
442 krb5_prepend_config_files_default(const char *filelist, char ***pfilenames)
444 krb5_error_code ret;
445 char **defpp, **pp = NULL;
447 ret = krb5_get_default_config_files(&defpp);
448 if (ret)
449 return ret;
451 ret = krb5_prepend_config_files(filelist, defpp, &pp);
452 krb5_free_config_files(defpp);
453 if (ret) {
454 return ret;
456 *pfilenames = pp;
457 return 0;
461 * Get the global configuration list.
463 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
465 * @return Returns 0 to indicate success. Otherwise an kerberos et
466 * error code is returned, see krb5_get_error_message().
468 * @ingroup krb5
471 krb5_error_code KRB5_LIB_FUNCTION
472 krb5_get_default_config_files(char ***pfilenames)
474 const char *files = NULL;
476 if (pfilenames == NULL)
477 return EINVAL;
478 if(!issuid())
479 files = getenv("KRB5_CONFIG");
480 if (files == NULL)
481 files = krb5_config_file;
483 return krb5_prepend_config_files(files, NULL, pfilenames);
487 * Free a list of configuration files.
489 * @param filenames list to be freed.
491 * @return Returns 0 to indicate success. Otherwise an kerberos et
492 * error code is returned, see krb5_get_error_message().
494 * @ingroup krb5
497 void KRB5_LIB_FUNCTION
498 krb5_free_config_files(char **filenames)
500 char **p;
501 for(p = filenames; *p != NULL; p++)
502 free(*p);
503 free(filenames);
507 * Returns the list of Kerberos encryption types sorted in order of
508 * most preferred to least preferred encryption type. Note that some
509 * encryption types might be disabled, so you need to check with
510 * krb5_enctype_valid() before using the encryption type.
512 * @return list of enctypes, terminated with ETYPE_NULL. Its a static
513 * array completed into the Kerberos library so the content doesn't
514 * need to be freed.
516 * @ingroup krb5
519 const krb5_enctype * KRB5_LIB_FUNCTION
520 krb5_kerberos_enctypes(krb5_context context)
522 static const krb5_enctype p[] = {
523 ETYPE_AES256_CTS_HMAC_SHA1_96,
524 ETYPE_AES128_CTS_HMAC_SHA1_96,
525 ETYPE_DES3_CBC_SHA1,
526 ETYPE_DES3_CBC_MD5,
527 ETYPE_ARCFOUR_HMAC_MD5,
528 ETYPE_DES_CBC_MD5,
529 ETYPE_DES_CBC_MD4,
530 ETYPE_DES_CBC_CRC,
531 ETYPE_NULL
533 return p;
537 * set `etype' to a malloced list of the default enctypes
540 static krb5_error_code
541 default_etypes(krb5_context context, krb5_enctype **etype)
543 const krb5_enctype *p;
544 krb5_enctype *e = NULL, *ep;
545 int i, n = 0;
547 p = krb5_kerberos_enctypes(context);
549 for (i = 0; p[i] != ETYPE_NULL; i++) {
550 if (krb5_enctype_valid(context, p[i]) != 0)
551 continue;
552 ep = realloc(e, (n + 2) * sizeof(*e));
553 if (ep == NULL) {
554 free(e);
555 krb5_set_error_string (context, "malloc: out of memory");
556 return ENOMEM;
558 e = ep;
559 e[n] = p[i];
560 e[n + 1] = ETYPE_NULL;
561 n++;
563 *etype = e;
564 return 0;
568 * Set the default encryption types that will be use in communcation
569 * with the KDC, clients and servers.
571 * @param context Kerberos 5 context.
572 * @param etypes Encryption types, array terminated with ETYPE_NULL (0).
574 * @return Returns 0 to indicate success. Otherwise an kerberos et
575 * error code is returned, see krb5_get_error_message().
577 * @ingroup krb5
580 krb5_error_code KRB5_LIB_FUNCTION
581 krb5_set_default_in_tkt_etypes(krb5_context context,
582 const krb5_enctype *etypes)
584 krb5_enctype *p = NULL;
585 int i;
587 if(etypes) {
588 for (i = 0; etypes[i]; ++i) {
589 krb5_error_code ret;
590 ret = krb5_enctype_valid(context, etypes[i]);
591 if (ret)
592 return ret;
594 ++i;
595 ALLOC(p, i);
596 if(!p) {
597 krb5_set_error_string (context, "malloc: out of memory");
598 return ENOMEM;
600 memmove(p, etypes, i * sizeof(krb5_enctype));
602 if(context->etypes)
603 free(context->etypes);
604 context->etypes = p;
605 return 0;
609 * Get the default encryption types that will be use in communcation
610 * with the KDC, clients and servers.
612 * @param context Kerberos 5 context.
613 * @param etypes Encryption types, array terminated with
614 * ETYPE_NULL(0), caller should free array with krb5_xfree():
616 * @return Returns 0 to indicate success. Otherwise an kerberos et
617 * error code is returned, see krb5_get_error_message().
619 * @ingroup krb5
622 krb5_error_code KRB5_LIB_FUNCTION
623 krb5_get_default_in_tkt_etypes(krb5_context context,
624 krb5_enctype **etypes)
626 krb5_enctype *p;
627 int i;
628 krb5_error_code ret;
630 if(context->etypes) {
631 for(i = 0; context->etypes[i]; i++);
632 ++i;
633 ALLOC(p, i);
634 if(!p) {
635 krb5_set_error_string (context, "malloc: out of memory");
636 return ENOMEM;
638 memmove(p, context->etypes, i * sizeof(krb5_enctype));
639 } else {
640 ret = default_etypes(context, &p);
641 if (ret)
642 return ret;
644 *etypes = p;
645 return 0;
649 * Return the error string for the error code. The caller must not
650 * free the string.
652 * @param context Kerberos 5 context.
653 * @param code Kerberos error code.
655 * @return the error message matching code
657 * @ingroup krb5
660 const char* KRB5_LIB_FUNCTION
661 krb5_get_err_text(krb5_context context, krb5_error_code code)
663 const char *p = NULL;
664 if(context != NULL)
665 p = com_right(context->et_list, code);
666 if(p == NULL)
667 p = strerror(code);
668 if (p == NULL)
669 p = "Unknown error";
670 return p;
674 * Init the built-in ets in the Kerberos library.
676 * @param context kerberos context to add the ets too
678 * @ingroup krb5
681 void KRB5_LIB_FUNCTION
682 krb5_init_ets(krb5_context context)
684 if(context->et_list == NULL){
685 krb5_add_et_list(context, initialize_krb5_error_table_r);
686 krb5_add_et_list(context, initialize_asn1_error_table_r);
687 krb5_add_et_list(context, initialize_heim_error_table_r);
688 krb5_add_et_list(context, initialize_k524_error_table_r);
689 #ifdef PKINIT
690 krb5_add_et_list(context, initialize_hx_error_table_r);
691 #endif
696 * Make the kerberos library default to the admin KDC.
698 * @param context Kerberos 5 context.
699 * @param flag boolean flag to select if the use the admin KDC or not.
701 * @ingroup krb5
704 void KRB5_LIB_FUNCTION
705 krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)
707 context->use_admin_kdc = flag;
711 * Make the kerberos library default to the admin KDC.
713 * @param context Kerberos 5 context.
715 * @return boolean flag to telling the context will use admin KDC as the default KDC.
717 * @ingroup krb5
720 krb5_boolean KRB5_LIB_FUNCTION
721 krb5_get_use_admin_kdc (krb5_context context)
723 return context->use_admin_kdc;
727 * Add extra address to the address list that the library will add to
728 * the client's address list when communicating with the KDC.
730 * @param context Kerberos 5 context.
731 * @param addresses addreses to add
733 * @return Returns 0 to indicate success. Otherwise an kerberos et
734 * error code is returned, see krb5_get_error_message().
736 * @ingroup krb5
739 krb5_error_code KRB5_LIB_FUNCTION
740 krb5_add_extra_addresses(krb5_context context, krb5_addresses *addresses)
743 if(context->extra_addresses)
744 return krb5_append_addresses(context,
745 context->extra_addresses, addresses);
746 else
747 return krb5_set_extra_addresses(context, addresses);
751 * Set extra address to the address list that the library will add to
752 * the client's address list when communicating with the KDC.
754 * @param context Kerberos 5 context.
755 * @param addresses addreses to set
757 * @return Returns 0 to indicate success. Otherwise an kerberos et
758 * error code is returned, see krb5_get_error_message().
760 * @ingroup krb5
763 krb5_error_code KRB5_LIB_FUNCTION
764 krb5_set_extra_addresses(krb5_context context, const krb5_addresses *addresses)
766 if(context->extra_addresses)
767 krb5_free_addresses(context, context->extra_addresses);
769 if(addresses == NULL) {
770 if(context->extra_addresses != NULL) {
771 free(context->extra_addresses);
772 context->extra_addresses = NULL;
774 return 0;
776 if(context->extra_addresses == NULL) {
777 context->extra_addresses = malloc(sizeof(*context->extra_addresses));
778 if(context->extra_addresses == NULL) {
779 krb5_set_error_string (context, "malloc: out of memory");
780 return ENOMEM;
783 return krb5_copy_addresses(context, addresses, context->extra_addresses);
787 * Get extra address to the address list that the library will add to
788 * the client's address list when communicating with the KDC.
790 * @param context Kerberos 5 context.
791 * @param addresses addreses to set
793 * @return Returns 0 to indicate success. Otherwise an kerberos et
794 * error code is returned, see krb5_get_error_message().
796 * @ingroup krb5
799 krb5_error_code KRB5_LIB_FUNCTION
800 krb5_get_extra_addresses(krb5_context context, krb5_addresses *addresses)
802 if(context->extra_addresses == NULL) {
803 memset(addresses, 0, sizeof(*addresses));
804 return 0;
806 return krb5_copy_addresses(context,context->extra_addresses, addresses);
810 * Add extra addresses to ignore when fetching addresses from the
811 * underlaying operating system.
813 * @param context Kerberos 5 context.
814 * @param addresses addreses to ignore
816 * @return Returns 0 to indicate success. Otherwise an kerberos et
817 * error code is returned, see krb5_get_error_message().
819 * @ingroup krb5
822 krb5_error_code KRB5_LIB_FUNCTION
823 krb5_add_ignore_addresses(krb5_context context, krb5_addresses *addresses)
826 if(context->ignore_addresses)
827 return krb5_append_addresses(context,
828 context->ignore_addresses, addresses);
829 else
830 return krb5_set_ignore_addresses(context, addresses);
834 * Set extra addresses to ignore when fetching addresses from the
835 * underlaying operating system.
837 * @param context Kerberos 5 context.
838 * @param addresses addreses to ignore
840 * @return Returns 0 to indicate success. Otherwise an kerberos et
841 * error code is returned, see krb5_get_error_message().
843 * @ingroup krb5
846 krb5_error_code KRB5_LIB_FUNCTION
847 krb5_set_ignore_addresses(krb5_context context, const krb5_addresses *addresses)
849 if(context->ignore_addresses)
850 krb5_free_addresses(context, context->ignore_addresses);
851 if(addresses == NULL) {
852 if(context->ignore_addresses != NULL) {
853 free(context->ignore_addresses);
854 context->ignore_addresses = NULL;
856 return 0;
858 if(context->ignore_addresses == NULL) {
859 context->ignore_addresses = malloc(sizeof(*context->ignore_addresses));
860 if(context->ignore_addresses == NULL) {
861 krb5_set_error_string (context, "malloc: out of memory");
862 return ENOMEM;
865 return krb5_copy_addresses(context, addresses, context->ignore_addresses);
869 * Get extra addresses to ignore when fetching addresses from the
870 * underlaying operating system.
872 * @param context Kerberos 5 context.
873 * @param addresses list addreses ignored
875 * @return Returns 0 to indicate success. Otherwise an kerberos et
876 * error code is returned, see krb5_get_error_message().
878 * @ingroup krb5
881 krb5_error_code KRB5_LIB_FUNCTION
882 krb5_get_ignore_addresses(krb5_context context, krb5_addresses *addresses)
884 if(context->ignore_addresses == NULL) {
885 memset(addresses, 0, sizeof(*addresses));
886 return 0;
888 return krb5_copy_addresses(context, context->ignore_addresses, addresses);
892 * Set version of fcache that the library should use.
894 * @param context Kerberos 5 context.
895 * @param version version number.
897 * @return Returns 0 to indicate success. Otherwise an kerberos et
898 * error code is returned, see krb5_get_error_message().
900 * @ingroup krb5
903 krb5_error_code KRB5_LIB_FUNCTION
904 krb5_set_fcache_version(krb5_context context, int version)
906 context->fcache_vno = version;
907 return 0;
911 * Get version of fcache that the library should use.
913 * @param context Kerberos 5 context.
914 * @param version version number.
916 * @return Returns 0 to indicate success. Otherwise an kerberos et
917 * error code is returned, see krb5_get_error_message().
919 * @ingroup krb5
922 krb5_error_code KRB5_LIB_FUNCTION
923 krb5_get_fcache_version(krb5_context context, int *version)
925 *version = context->fcache_vno;
926 return 0;
930 * Runtime check if the Kerberos library was complied with thread support.
932 * @return TRUE if the library was compiled with thread support, FALSE if not.
934 * @ingroup krb5
938 krb5_boolean KRB5_LIB_FUNCTION
939 krb5_is_thread_safe(void)
941 #ifdef ENABLE_PTHREAD_SUPPORT
942 return TRUE;
943 #else
944 return FALSE;
945 #endif
949 * Set if the library should use DNS to canonicalize hostnames.
951 * @param context Kerberos 5 context.
952 * @param flag if its dns canonicalizion is used or not.
954 * @ingroup krb5
957 void KRB5_LIB_FUNCTION
958 krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)
960 if (flag)
961 context->flags |= KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
962 else
963 context->flags &= ~KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME;
967 * Get if the library uses DNS to canonicalize hostnames.
969 * @param context Kerberos 5 context.
971 * @return return non zero if the library uses DNS to canonicalize hostnames.
973 * @ingroup krb5
976 krb5_boolean KRB5_LIB_FUNCTION
977 krb5_get_dns_canonicalize_hostname (krb5_context context)
979 return (context->flags & KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME) ? 1 : 0;
983 * Get current offset in time to the KDC.
985 * @param context Kerberos 5 context.
986 * @param sec seconds part of offset.
987 * @param usec micro seconds part of offset.
989 * @return return non zero if the library uses DNS to canonicalize hostnames.
991 * @ingroup krb5
994 krb5_error_code KRB5_LIB_FUNCTION
995 krb5_get_kdc_sec_offset (krb5_context context, int32_t *sec, int32_t *usec)
997 if (sec)
998 *sec = context->kdc_sec_offset;
999 if (usec)
1000 *usec = context->kdc_usec_offset;
1001 return 0;
1005 * Get max time skew allowed.
1007 * @param context Kerberos 5 context.
1009 * @return timeskew in seconds.
1011 * @ingroup krb5
1014 time_t KRB5_LIB_FUNCTION
1015 krb5_get_max_time_skew (krb5_context context)
1017 return context->max_skew;
1021 * Set max time skew allowed.
1023 * @param context Kerberos 5 context.
1024 * @param t timeskew in seconds.
1026 * @ingroup krb5
1029 void KRB5_LIB_FUNCTION
1030 krb5_set_max_time_skew (krb5_context context, time_t t)
1032 context->max_skew = t;