2 * Copyright (c) 1997 - 2010 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #undef KRB5_DEPRECATED_FUNCTION
37 #define KRB5_DEPRECATED_FUNCTION(x)
39 #include "krb5_locl.h"
43 static void _krb5_init_ets(krb5_context
);
45 #define INIT_FIELD(C, T, E, D, F) \
46 (C)->E = krb5_config_get_ ## T ## _default ((C), NULL, (D), \
47 "libdefaults", F, NULL)
49 #define INIT_FLAG(C, O, V, D, F) \
51 if (krb5_config_get_bool_default((C), NULL, (D),"libdefaults", F, NULL)) { \
56 static krb5_error_code
57 copy_enctypes(krb5_context context
,
58 const krb5_enctype
*in
,
62 * Set the list of etypes `ret_etypes' from the configuration variable
66 static krb5_error_code
67 set_etypes (krb5_context context
,
69 krb5_enctype
**ret_enctypes
)
72 krb5_enctype
*etypes
= NULL
;
74 etypes_str
= krb5_config_get_strings(context
, NULL
, "libdefaults",
78 for(i
= 0; etypes_str
[i
]; i
++);
79 etypes
= malloc((i
+1) * sizeof(*etypes
));
81 krb5_config_free_strings (etypes_str
);
82 return krb5_enomem(context
);
84 for(j
= 0, k
= 0; j
< i
; j
++) {
86 if(krb5_string_to_enctype(context
, etypes_str
[j
], &e
) != 0)
88 if (krb5_enctype_valid(context
, e
) != 0)
92 etypes
[k
] = ETYPE_NULL
;
93 krb5_config_free_strings(etypes_str
);
95 *ret_enctypes
= etypes
;
100 * read variables from the configuration file and set in `context'
103 static krb5_error_code
104 init_context_from_config_file(krb5_context context
)
109 krb5_enctype
*tmptypes
;
111 INIT_FIELD(context
, time
, max_skew
, 5 * 60, "clockskew");
112 INIT_FIELD(context
, time
, kdc_timeout
, 30, "kdc_timeout");
113 INIT_FIELD(context
, time
, host_timeout
, 3, "host_timeout");
114 INIT_FIELD(context
, int, max_retries
, 3, "max_retries");
116 INIT_FIELD(context
, string
, http_proxy
, NULL
, "http_proxy");
118 ret
= krb5_config_get_bool_default(context
, NULL
, FALSE
,
120 "allow_weak_crypto", NULL
);
122 krb5_enctype_enable(context
, ETYPE_DES_CBC_CRC
);
123 krb5_enctype_enable(context
, ETYPE_DES_CBC_MD4
);
124 krb5_enctype_enable(context
, ETYPE_DES_CBC_MD5
);
125 krb5_enctype_enable(context
, ETYPE_DES_CBC_NONE
);
126 krb5_enctype_enable(context
, ETYPE_DES_CFB64_NONE
);
127 krb5_enctype_enable(context
, ETYPE_DES_PCBC_NONE
);
130 ret
= set_etypes (context
, "default_etypes", &tmptypes
);
133 free(context
->etypes
);
134 context
->etypes
= tmptypes
;
136 /* The etypes member may change during the lifetime
137 * of the context. To be able to reset it to
138 * config value, we keep another copy.
140 free(context
->cfg_etypes
);
141 context
->cfg_etypes
= NULL
;
143 ret
= copy_enctypes(context
, tmptypes
, &context
->cfg_etypes
);
148 ret
= set_etypes (context
, "default_etypes_des", &tmptypes
);
151 free(context
->etypes_des
);
152 context
->etypes_des
= tmptypes
;
154 ret
= set_etypes (context
, "default_as_etypes", &tmptypes
);
157 free(context
->as_etypes
);
158 context
->as_etypes
= tmptypes
;
160 ret
= set_etypes (context
, "default_tgs_etypes", &tmptypes
);
163 free(context
->tgs_etypes
);
164 context
->tgs_etypes
= tmptypes
;
166 ret
= set_etypes (context
, "permitted_enctypes", &tmptypes
);
169 free(context
->permitted_enctypes
);
170 context
->permitted_enctypes
= tmptypes
;
172 INIT_FIELD(context
, string
, default_keytab
,
173 KEYTAB_DEFAULT
, "default_keytab_name");
175 INIT_FIELD(context
, string
, default_keytab_modify
,
176 NULL
, "default_keytab_modify_name");
178 INIT_FIELD(context
, string
, time_fmt
,
179 "%Y-%m-%dT%H:%M:%S", "time_format");
181 INIT_FIELD(context
, string
, date_fmt
,
182 "%Y-%m-%d", "date_format");
184 INIT_FIELD(context
, bool, log_utc
,
187 context
->no_ticket_store
=
188 getenv("KRB5_NO_TICKET_STORE") != NULL
;
190 /* init dns-proxy slime */
191 tmp
= krb5_config_get_string(context
, NULL
, "libdefaults",
194 roken_gethostby_setup(context
->http_proxy
, tmp
);
195 krb5_free_host_realm (context
, context
->default_realms
);
196 context
->default_realms
= NULL
;
199 krb5_addresses addresses
;
202 krb5_set_extra_addresses(context
, NULL
);
203 adr
= krb5_config_get_strings(context
, NULL
,
207 memset(&addresses
, 0, sizeof(addresses
));
208 for(a
= adr
; a
&& *a
; a
++) {
209 ret
= krb5_parse_address(context
, *a
, &addresses
);
211 krb5_add_extra_addresses(context
, &addresses
);
212 krb5_free_addresses(context
, &addresses
);
215 krb5_config_free_strings(adr
);
217 krb5_set_ignore_addresses(context
, NULL
);
218 adr
= krb5_config_get_strings(context
, NULL
,
222 memset(&addresses
, 0, sizeof(addresses
));
223 for(a
= adr
; a
&& *a
; a
++) {
224 ret
= krb5_parse_address(context
, *a
, &addresses
);
226 krb5_add_ignore_addresses(context
, &addresses
);
227 krb5_free_addresses(context
, &addresses
);
230 krb5_config_free_strings(adr
);
233 INIT_FIELD(context
, bool, scan_interfaces
, TRUE
, "scan_interfaces");
234 INIT_FIELD(context
, int, fcache_vno
, 0, "fcache_version");
235 /* prefer dns_lookup_kdc over srv_lookup. */
236 INIT_FIELD(context
, bool, srv_lookup
, TRUE
, "srv_lookup");
237 INIT_FIELD(context
, bool, srv_lookup
, context
->srv_lookup
, "dns_lookup_kdc");
238 INIT_FIELD(context
, int, large_msg_size
, 1400, "large_message_size");
239 INIT_FIELD(context
, int, max_msg_size
, 1000 * 1024, "maximum_message_size");
240 INIT_FLAG(context
, flags
, KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
, TRUE
, "dns_canonicalize_hostname");
241 INIT_FLAG(context
, flags
, KRB5_CTX_F_CHECK_PAC
, TRUE
, "check_pac");
242 INIT_FLAG(context
, flags
, KRB5_CTX_F_ENFORCE_OK_AS_DELEGATE
, FALSE
, "enforce_ok_as_delegate");
244 if (context
->default_cc_name
)
245 free(context
->default_cc_name
);
246 context
->default_cc_name
= NULL
;
247 context
->default_cc_name_set
= 0;
248 context
->configured_default_cc_name
= NULL
;
250 tmp
= secure_getenv("KRB5_TRACE");
252 heim_add_debug_dest(context
->hcontext
, "libkrb5", tmp
);
253 s
= krb5_config_get_strings(context
, NULL
, "logging", "krb5", NULL
);
258 heim_add_debug_dest(context
->hcontext
, "libkrb5", *p
);
259 krb5_config_free_strings(s
);
262 tmp
= krb5_config_get_string(context
, NULL
, "libdefaults",
263 "check-rd-req-server", NULL
);
265 tmp
= secure_getenv("KRB5_CHECK_RD_REQ_SERVER");
267 if (strcasecmp(tmp
, "ignore") == 0)
268 context
->flags
|= KRB5_CTX_F_RD_REQ_IGNORE
;
270 ret
= krb5_config_get_bool_default(context
, NULL
, TRUE
,
272 "fcache_strict_checking", NULL
);
274 context
->flags
|= KRB5_CTX_F_FCACHE_STRICT_CHECKING
;
279 static krb5_error_code
280 cc_ops_register(krb5_context context
)
282 context
->cc_ops
= NULL
;
283 context
->num_cc_ops
= 0;
285 #ifndef KCM_IS_API_CACHE
286 krb5_cc_register(context
, &krb5_acc_ops
, TRUE
);
288 krb5_cc_register(context
, &krb5_fcc_ops
, TRUE
);
289 krb5_cc_register(context
, &krb5_dcc_ops
, TRUE
);
290 krb5_cc_register(context
, &krb5_mcc_ops
, TRUE
);
292 krb5_cc_register(context
, &krb5_scc_ops
, TRUE
);
295 #ifdef KCM_IS_API_CACHE
296 krb5_cc_register(context
, &krb5_akcm_ops
, TRUE
);
298 krb5_cc_register(context
, &krb5_kcm_ops
, TRUE
);
300 #if defined(HAVE_KEYUTILS_H)
301 krb5_cc_register(context
, &krb5_krcc_ops
, TRUE
);
303 _krb5_load_ccache_plugins(context
);
307 static krb5_error_code
308 cc_ops_copy(krb5_context context
, const krb5_context src_context
)
310 const krb5_cc_ops
**cc_ops
;
312 context
->cc_ops
= NULL
;
313 context
->num_cc_ops
= 0;
315 if (src_context
->num_cc_ops
== 0)
318 cc_ops
= malloc(sizeof(cc_ops
[0]) * src_context
->num_cc_ops
);
319 if (cc_ops
== NULL
) {
320 krb5_set_error_message(context
, KRB5_CC_NOMEM
,
321 N_("malloc: out of memory", ""));
322 return KRB5_CC_NOMEM
;
325 memcpy(rk_UNCONST(cc_ops
), src_context
->cc_ops
,
326 sizeof(cc_ops
[0]) * src_context
->num_cc_ops
);
327 context
->cc_ops
= cc_ops
;
328 context
->num_cc_ops
= src_context
->num_cc_ops
;
333 static krb5_error_code
334 kt_ops_register(krb5_context context
)
336 context
->num_kt_types
= 0;
337 context
->kt_types
= NULL
;
339 krb5_kt_register (context
, &krb5_fkt_ops
);
340 krb5_kt_register (context
, &krb5_wrfkt_ops
);
341 krb5_kt_register (context
, &krb5_javakt_ops
);
342 krb5_kt_register (context
, &krb5_mkt_ops
);
343 #ifndef HEIMDAL_SMALLER
344 krb5_kt_register (context
, &krb5_akf_ops
);
346 krb5_kt_register (context
, &krb5_any_ops
);
350 static krb5_error_code
351 kt_ops_copy(krb5_context context
, const krb5_context src_context
)
353 context
->num_kt_types
= 0;
354 context
->kt_types
= NULL
;
356 if (src_context
->num_kt_types
== 0)
359 context
->kt_types
= malloc(sizeof(context
->kt_types
[0]) * src_context
->num_kt_types
);
360 if (context
->kt_types
== NULL
)
361 return krb5_enomem(context
);
363 context
->num_kt_types
= src_context
->num_kt_types
;
364 memcpy(context
->kt_types
, src_context
->kt_types
,
365 sizeof(context
->kt_types
[0]) * src_context
->num_kt_types
);
370 static const char *sysplugin_dirs
[] = {
374 "$ORIGIN/../lib/plugin/krb5",
377 LIBDIR
"/plugin/krb5",
378 #ifdef HEIM_PLUGINS_SEARCH_SYSTEM
379 "/Library/KerberosPlugins/KerberosFrameworkPlugins",
380 "/System/Library/KerberosPlugins/KerberosFrameworkPlugins",
387 init_context_once(void *ctx
)
389 krb5_context context
= ctx
;
393 dirs
= rk_UNCONST(sysplugin_dirs
);
395 dirs
= krb5_config_get_strings(context
, NULL
, "libdefaults",
398 dirs
= rk_UNCONST(sysplugin_dirs
);
401 _krb5_load_plugins(context
, "krb5", (const char **)dirs
);
403 if (dirs
!= rk_UNCONST(sysplugin_dirs
))
404 krb5_config_free_strings(dirs
);
406 bindtextdomain(HEIMDAL_TEXTDOMAIN
, HEIMDAL_LOCALEDIR
);
410 * Initializes the context structure and reads the configuration file
411 * /etc/krb5.conf. The structure should be freed by calling
412 * krb5_free_context() when it is no longer being used.
414 * @param context pointer to returned context
416 * @return Returns 0 to indicate success. Otherwise an errno code is
417 * returned. Failure means either that something bad happened during
418 * initialization (typically ENOMEM) or that Kerberos should not be
419 * used ENXIO. If the function returns HEIM_ERR_RANDOM_OFFLINE, the
420 * random source is not available and later Kerberos calls might fail.
425 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
426 krb5_init_context(krb5_context
*context
)
428 static heim_base_once_t init_context
= HEIM_BASE_ONCE_INIT
;
437 * krb5_init_context() will get one random byte to make sure our
438 * random is alive. Assumption is that once the non blocking
439 * source allows us to pull bytes, its all seeded and allows us to
442 * Most Kerberos users calls krb5_init_context(), so this is
443 * useful point where we can do the checking.
445 ret
= krb5_generate_random(&rnd
, sizeof(rnd
));
449 p
= calloc(1, sizeof(*p
));
453 if ((p
->hcontext
= heim_context_init()) == NULL
) {
459 p
->flags
|= KRB5_CTX_F_HOMEDIR_ACCESS
;
461 ret
= krb5_get_default_config_files(&files
);
464 ret
= krb5_set_config_files(p
, files
);
465 krb5_free_config_files(files
);
469 /* done enough to load plugins */
470 heim_base_once_f(&init_context
, p
, init_context_once
);
472 /* init error tables */
478 ret
= hx509_context_init(&p
->hx509ctx
);
483 p
->flags
|= KRB5_CTX_F_SOCKETS_INITIALIZED
;
487 krb5_free_context(p
);
490 heim_context_set_log_utc(p
->hcontext
, p
->log_utc
);
496 #ifndef HEIMDAL_SMALLER
498 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
499 krb5_get_permitted_enctypes(krb5_context context
,
500 krb5_enctype
**etypes
)
502 return krb5_get_default_in_tkt_etypes(context
, KRB5_PDU_NONE
, etypes
);
509 static krb5_error_code
510 copy_etypes (krb5_context context
,
511 krb5_enctype
*enctypes
,
512 krb5_enctype
**ret_enctypes
)
516 for (i
= 0; enctypes
[i
]; i
++)
520 *ret_enctypes
= malloc(sizeof(enctypes
[0]) * i
);
521 if (*ret_enctypes
== NULL
)
522 return krb5_enomem(context
);
523 memcpy(*ret_enctypes
, enctypes
, sizeof(enctypes
[0]) * i
);
528 * Make a copy for the Kerberos 5 context, the new krb5_context shoud
529 * be freed with krb5_free_context().
531 * @param context the Kerberos context to copy
532 * @param out the copy of the Kerberos, set to NULL error.
534 * @return Returns 0 to indicate success. Otherwise an kerberos et
535 * error code is returned, see krb5_get_error_message().
540 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
541 krb5_copy_context(krb5_context context
, krb5_context
*out
)
548 p
= calloc(1, sizeof(*p
));
550 return krb5_enomem(context
);
552 if ((p
->hcontext
= heim_context_init()) == NULL
) {
557 heim_context_set_log_utc(p
->hcontext
, context
->log_utc
);
559 if (context
->default_cc_name
&&
560 (p
->default_cc_name
= strdup(context
->default_cc_name
)) == NULL
) {
564 if (context
->default_cc_name_env
&&
565 (p
->default_cc_name_env
=
566 strdup(context
->default_cc_name_env
)) == NULL
) {
570 if (context
->configured_default_cc_name
&&
571 (p
->configured_default_cc_name
=
572 strdup(context
->configured_default_cc_name
)) == NULL
) {
577 if (context
->etypes
) {
578 ret
= copy_etypes(context
, context
->etypes
, &p
->etypes
);
582 if (context
->cfg_etypes
) {
583 ret
= copy_etypes(context
, context
->cfg_etypes
, &p
->cfg_etypes
);
587 if (context
->etypes_des
) {
588 ret
= copy_etypes(context
, context
->etypes_des
, &p
->etypes_des
);
593 if (context
->default_realms
) {
594 ret
= krb5_copy_host_realm(context
,
595 context
->default_realms
, &p
->default_realms
);
600 ret
= _krb5_config_copy(context
, context
->cf
, &p
->cf
);
604 /* XXX should copy */
607 cc_ops_copy(p
, context
);
608 kt_ops_copy(p
, context
);
610 ret
= krb5_set_extra_addresses(p
, context
->extra_addresses
);
613 ret
= krb5_set_extra_addresses(p
, context
->ignore_addresses
);
617 ret
= _krb5_copy_send_to_kdc_func(p
, context
);
626 krb5_free_context(p
);
633 * Frees the krb5_context allocated by krb5_init_context().
635 * @param context context to be freed.
640 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
641 krb5_free_context(krb5_context context
)
643 _krb5_free_name_canon_rules(context
, context
->name_canon_rules
);
644 if (context
->default_cc_name
)
645 free(context
->default_cc_name
);
646 if (context
->default_cc_name_env
)
647 free(context
->default_cc_name_env
);
648 if (context
->configured_default_cc_name
)
649 free(context
->configured_default_cc_name
);
650 free(context
->etypes
);
651 free(context
->cfg_etypes
);
652 free(context
->etypes_des
);
653 free(context
->permitted_enctypes
);
654 free(context
->tgs_etypes
);
655 free(context
->as_etypes
);
656 krb5_free_host_realm (context
, context
->default_realms
);
657 krb5_config_file_free (context
, context
->cf
);
658 free(rk_UNCONST(context
->cc_ops
));
659 free(context
->kt_types
);
660 krb5_clear_error_message(context
);
661 krb5_set_extra_addresses(context
, NULL
);
662 krb5_set_ignore_addresses(context
, NULL
);
663 krb5_set_send_to_kdc_func(context
, NULL
, NULL
);
666 hx509_context_free(&context
->hx509ctx
);
669 if (context
->flags
& KRB5_CTX_F_SOCKETS_INITIALIZED
) {
673 heim_context_free(&context
->hcontext
);
674 memset(context
, 0, sizeof(*context
));
679 * Reinit the context from a new set of filenames.
681 * @param context context to add configuration too.
682 * @param filenames array of filenames, end of list is indicated with a NULL filename.
684 * @return Returns 0 to indicate success. Otherwise an kerberos et
685 * error code is returned, see krb5_get_error_message().
690 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
691 krb5_set_config_files(krb5_context context
, char **filenames
)
694 heim_config_binding
*tmp
= NULL
;
696 if ((ret
= heim_set_config_files(context
->hcontext
, filenames
,
699 krb5_config_file_free(context
, context
->cf
);
700 context
->cf
= (krb5_config_binding
*)tmp
;
701 return init_context_from_config_file(context
);
704 #ifndef HEIMDAL_SMALLER
706 * Reinit the context from configuration file contents in a C string.
707 * This should only be used in tests.
709 * @param context context to add configuration too.
710 * @param config configuration.
712 * @return Returns 0 to indicate success. Otherwise an kerberos et
713 * error code is returned, see krb5_get_error_message().
718 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
719 krb5_set_config(krb5_context context
, const char *config
)
722 krb5_config_binding
*tmp
= NULL
;
724 if ((ret
= krb5_config_parse_string_multi(context
, config
, &tmp
)))
727 /* with this enabled and if there are no config files, Kerberos is
728 considererd disabled */
733 krb5_config_file_free(context
, context
->cf
);
735 ret
= init_context_from_config_file(context
);
741 * `pq' isn't free, it's up the the caller
744 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
745 krb5_prepend_config_files(const char *filelist
, char **pq
, char ***ret_pp
)
747 return heim_prepend_config_files(filelist
, pq
, ret_pp
);
751 * Prepend the filename to the global configuration list.
753 * @param filelist a filename to add to the default list of filename
754 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
756 * @return Returns 0 to indicate success. Otherwise an kerberos et
757 * error code is returned, see krb5_get_error_message().
762 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
763 krb5_prepend_config_files_default(const char *filelist
, char ***pfilenames
)
765 return heim_prepend_config_files_default(filelist
, krb5_config_file
,
766 "KRB5_CONFIG", pfilenames
);
770 * Get the global configuration list.
772 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
774 * @return Returns 0 to indicate success. Otherwise an kerberos et
775 * error code is returned, see krb5_get_error_message().
780 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
781 krb5_get_default_config_files(char ***pfilenames
)
783 if (pfilenames
== NULL
)
785 return heim_get_default_config_files(krb5_config_file
, "KRB5_CONFIG",
790 * Free a list of configuration files.
792 * @param filenames list, terminated with a NULL pointer, to be
793 * freed. NULL is an valid argument.
795 * @return Returns 0 to indicate success. Otherwise an kerberos et
796 * error code is returned, see krb5_get_error_message().
801 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
802 krb5_free_config_files(char **filenames
)
804 heim_free_config_files(filenames
);
808 * Returns the list of Kerberos encryption types sorted in order of
809 * most preferred to least preferred encryption type. Note that some
810 * encryption types might be disabled, so you need to check with
811 * krb5_enctype_valid() before using the encryption type.
813 * @return list of enctypes, terminated with ETYPE_NULL. Its a static
814 * array completed into the Kerberos library so the content doesn't
820 KRB5_LIB_FUNCTION
const krb5_enctype
* KRB5_LIB_CALL
821 krb5_kerberos_enctypes(krb5_context context
)
823 static const krb5_enctype p
[] = {
824 ETYPE_AES256_CTS_HMAC_SHA1_96
,
825 ETYPE_AES128_CTS_HMAC_SHA1_96
,
826 ETYPE_AES256_CTS_HMAC_SHA384_192
,
827 ETYPE_AES128_CTS_HMAC_SHA256_128
,
829 ETYPE_ARCFOUR_HMAC_MD5
,
833 static const krb5_enctype weak
[] = {
834 ETYPE_AES256_CTS_HMAC_SHA1_96
,
835 ETYPE_AES128_CTS_HMAC_SHA1_96
,
836 ETYPE_AES256_CTS_HMAC_SHA384_192
,
837 ETYPE_AES128_CTS_HMAC_SHA256_128
,
840 ETYPE_ARCFOUR_HMAC_MD5
,
848 * if the list of enctypes enabled by "allow_weak_crypto"
849 * are valid, then return the former default enctype list
850 * that contained the weak entries.
852 if (krb5_enctype_valid(context
, ETYPE_DES_CBC_CRC
) == 0 &&
853 krb5_enctype_valid(context
, ETYPE_DES_CBC_MD4
) == 0 &&
854 krb5_enctype_valid(context
, ETYPE_DES_CBC_MD5
) == 0 &&
855 krb5_enctype_valid(context
, ETYPE_DES_CBC_NONE
) == 0 &&
856 krb5_enctype_valid(context
, ETYPE_DES_CFB64_NONE
) == 0 &&
857 krb5_enctype_valid(context
, ETYPE_DES_PCBC_NONE
) == 0)
867 static krb5_error_code
868 copy_enctypes(krb5_context context
,
869 const krb5_enctype
*in
,
872 krb5_enctype
*p
= NULL
;
875 for (n
= 0; in
[n
]; n
++)
880 return krb5_enomem(context
);
881 for (n
= 0, m
= 0; in
[n
]; n
++) {
882 if (krb5_enctype_valid(context
, in
[n
]) != 0)
886 p
[m
] = KRB5_ENCTYPE_NULL
;
889 krb5_set_error_message (context
, KRB5_PROG_ETYPE_NOSUPP
,
890 N_("no valid enctype set", ""));
891 return KRB5_PROG_ETYPE_NOSUPP
;
899 * set `etype' to a malloced list of the default enctypes
902 static krb5_error_code
903 default_etypes(krb5_context context
, krb5_enctype
**etype
)
905 const krb5_enctype
*p
= krb5_kerberos_enctypes(context
);
906 return copy_enctypes(context
, p
, etype
);
910 * Set the default encryption types that will be use in communcation
911 * with the KDC, clients and servers.
913 * @param context Kerberos 5 context.
914 * @param etypes Encryption types, array terminated with ETYPE_NULL (0).
915 * A value of NULL resets the encryption types to the defaults set in the
916 * configuration file.
918 * @return Returns 0 to indicate success. Otherwise an kerberos et
919 * error code is returned, see krb5_get_error_message().
924 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
925 krb5_set_default_in_tkt_etypes(krb5_context context
,
926 const krb5_enctype
*etypes
)
929 krb5_enctype
*p
= NULL
;
932 etypes
= context
->cfg_etypes
;
936 ret
= copy_enctypes(context
, etypes
, &p
);
941 free(context
->etypes
);
947 * Get the default encryption types that will be use in communcation
948 * with the KDC, clients and servers.
950 * @param context Kerberos 5 context.
951 * @param pdu_type request type (AS, TGS or none)
952 * @param etypes Encryption types, array terminated with
953 * ETYPE_NULL(0), caller should free array with krb5_xfree():
955 * @return Returns 0 to indicate success. Otherwise an kerberos et
956 * error code is returned, see krb5_get_error_message().
961 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
962 krb5_get_default_in_tkt_etypes(krb5_context context
,
964 krb5_enctype
**etypes
)
966 krb5_enctype
*enctypes
= NULL
;
970 heim_assert(pdu_type
== KRB5_PDU_AS_REQUEST
||
971 pdu_type
== KRB5_PDU_TGS_REQUEST
||
972 pdu_type
== KRB5_PDU_NONE
, "unexpected pdu type");
974 if (pdu_type
== KRB5_PDU_AS_REQUEST
&& context
->as_etypes
!= NULL
)
975 enctypes
= context
->as_etypes
;
976 else if (pdu_type
== KRB5_PDU_TGS_REQUEST
&& context
->tgs_etypes
!= NULL
)
977 enctypes
= context
->tgs_etypes
;
978 else if (context
->etypes
!= NULL
)
979 enctypes
= context
->etypes
;
981 if (enctypes
!= NULL
) {
982 ret
= copy_enctypes(context
, enctypes
, &p
);
986 ret
= default_etypes(context
, &p
);
995 * Init the built-in ets in the Kerberos library.
997 * @param context kerberos context to add the ets too
1002 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1003 krb5_init_ets(krb5_context context
)
1008 _krb5_init_ets(krb5_context context
)
1010 heim_add_et_list(context
->hcontext
, initialize_krb5_error_table_r
);
1011 heim_add_et_list(context
->hcontext
, initialize_asn1_error_table_r
);
1012 heim_add_et_list(context
->hcontext
, initialize_heim_error_table_r
);
1014 heim_add_et_list(context
->hcontext
, initialize_k524_error_table_r
);
1015 heim_add_et_list(context
->hcontext
, initialize_k5e1_error_table_r
);
1017 #ifdef COM_ERR_BINDDOMAIN_krb5
1018 bindtextdomain(COM_ERR_BINDDOMAIN_krb5
, HEIMDAL_LOCALEDIR
);
1019 bindtextdomain(COM_ERR_BINDDOMAIN_asn1
, HEIMDAL_LOCALEDIR
);
1020 bindtextdomain(COM_ERR_BINDDOMAIN_heim
, HEIMDAL_LOCALEDIR
);
1021 bindtextdomain(COM_ERR_BINDDOMAIN_k524
, HEIMDAL_LOCALEDIR
);
1025 heim_add_et_list(context
->hcontext
, initialize_hx_error_table_r
);
1026 #ifdef COM_ERR_BINDDOMAIN_hx
1027 bindtextdomain(COM_ERR_BINDDOMAIN_hx
, HEIMDAL_LOCALEDIR
);
1033 * Make the kerberos library default to the admin KDC.
1035 * @param context Kerberos 5 context.
1036 * @param flag boolean flag to select if the use the admin KDC or not.
1041 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1042 krb5_set_use_admin_kdc (krb5_context context
, krb5_boolean flag
)
1044 context
->use_admin_kdc
= flag
;
1048 * Make the kerberos library default to the admin KDC.
1050 * @param context Kerberos 5 context.
1052 * @return boolean flag to telling the context will use admin KDC as the default KDC.
1057 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1058 krb5_get_use_admin_kdc (krb5_context context
)
1060 return context
->use_admin_kdc
;
1064 * Add extra address to the address list that the library will add to
1065 * the client's address list when communicating with the KDC.
1067 * @param context Kerberos 5 context.
1068 * @param addresses addreses to add
1070 * @return Returns 0 to indicate success. Otherwise an kerberos et
1071 * error code is returned, see krb5_get_error_message().
1076 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1077 krb5_add_extra_addresses(krb5_context context
, krb5_addresses
*addresses
)
1080 if(context
->extra_addresses
)
1081 return krb5_append_addresses(context
,
1082 context
->extra_addresses
, addresses
);
1084 return krb5_set_extra_addresses(context
, addresses
);
1088 * Set extra address to the address list that the library will add to
1089 * the client's address list when communicating with the KDC.
1091 * @param context Kerberos 5 context.
1092 * @param addresses addreses to set
1094 * @return Returns 0 to indicate success. Otherwise an kerberos et
1095 * error code is returned, see krb5_get_error_message().
1100 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1101 krb5_set_extra_addresses(krb5_context context
, const krb5_addresses
*addresses
)
1103 if(context
->extra_addresses
)
1104 krb5_free_addresses(context
, context
->extra_addresses
);
1106 if(addresses
== NULL
) {
1107 if(context
->extra_addresses
!= NULL
) {
1108 free(context
->extra_addresses
);
1109 context
->extra_addresses
= NULL
;
1113 if(context
->extra_addresses
== NULL
) {
1114 context
->extra_addresses
= malloc(sizeof(*context
->extra_addresses
));
1115 if (context
->extra_addresses
== NULL
)
1116 return krb5_enomem(context
);
1118 return krb5_copy_addresses(context
, addresses
, context
->extra_addresses
);
1122 * Get extra address to the address list that the library will add to
1123 * the client's address list when communicating with the KDC.
1125 * @param context Kerberos 5 context.
1126 * @param addresses addreses to set
1128 * @return Returns 0 to indicate success. Otherwise an kerberos et
1129 * error code is returned, see krb5_get_error_message().
1134 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1135 krb5_get_extra_addresses(krb5_context context
, krb5_addresses
*addresses
)
1137 if(context
->extra_addresses
== NULL
) {
1138 memset(addresses
, 0, sizeof(*addresses
));
1141 return krb5_copy_addresses(context
,context
->extra_addresses
, addresses
);
1145 * Add extra addresses to ignore when fetching addresses from the
1146 * underlaying operating system.
1148 * @param context Kerberos 5 context.
1149 * @param addresses addreses to ignore
1151 * @return Returns 0 to indicate success. Otherwise an kerberos et
1152 * error code is returned, see krb5_get_error_message().
1157 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1158 krb5_add_ignore_addresses(krb5_context context
, krb5_addresses
*addresses
)
1161 if(context
->ignore_addresses
)
1162 return krb5_append_addresses(context
,
1163 context
->ignore_addresses
, addresses
);
1165 return krb5_set_ignore_addresses(context
, addresses
);
1169 * Set extra addresses to ignore when fetching addresses from the
1170 * underlaying operating system.
1172 * @param context Kerberos 5 context.
1173 * @param addresses addreses to ignore
1175 * @return Returns 0 to indicate success. Otherwise an kerberos et
1176 * error code is returned, see krb5_get_error_message().
1181 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1182 krb5_set_ignore_addresses(krb5_context context
, const krb5_addresses
*addresses
)
1184 if(context
->ignore_addresses
)
1185 krb5_free_addresses(context
, context
->ignore_addresses
);
1186 if(addresses
== NULL
) {
1187 if(context
->ignore_addresses
!= NULL
) {
1188 free(context
->ignore_addresses
);
1189 context
->ignore_addresses
= NULL
;
1193 if(context
->ignore_addresses
== NULL
) {
1194 context
->ignore_addresses
= malloc(sizeof(*context
->ignore_addresses
));
1195 if (context
->ignore_addresses
== NULL
)
1196 return krb5_enomem(context
);
1198 return krb5_copy_addresses(context
, addresses
, context
->ignore_addresses
);
1202 * Get extra addresses to ignore when fetching addresses from the
1203 * underlaying operating system.
1205 * @param context Kerberos 5 context.
1206 * @param addresses list addreses ignored
1208 * @return Returns 0 to indicate success. Otherwise an kerberos et
1209 * error code is returned, see krb5_get_error_message().
1214 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1215 krb5_get_ignore_addresses(krb5_context context
, krb5_addresses
*addresses
)
1217 if(context
->ignore_addresses
== NULL
) {
1218 memset(addresses
, 0, sizeof(*addresses
));
1221 return krb5_copy_addresses(context
, context
->ignore_addresses
, addresses
);
1225 * Set version of fcache that the library should use.
1227 * @param context Kerberos 5 context.
1228 * @param version version number.
1230 * @return Returns 0 to indicate success. Otherwise an kerberos et
1231 * error code is returned, see krb5_get_error_message().
1236 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1237 krb5_set_fcache_version(krb5_context context
, int version
)
1239 context
->fcache_vno
= version
;
1244 * Get version of fcache that the library should use.
1246 * @param context Kerberos 5 context.
1247 * @param version version number.
1249 * @return Returns 0 to indicate success. Otherwise an kerberos et
1250 * error code is returned, see krb5_get_error_message().
1255 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1256 krb5_get_fcache_version(krb5_context context
, int *version
)
1258 *version
= context
->fcache_vno
;
1263 * Runtime check if the Kerberos library was complied with thread support.
1265 * @return TRUE if the library was compiled with thread support, FALSE if not.
1271 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1272 krb5_is_thread_safe(void)
1274 #ifdef ENABLE_PTHREAD_SUPPORT
1282 * Set if the library should use DNS to canonicalize hostnames.
1284 * @param context Kerberos 5 context.
1285 * @param flag if its dns canonicalizion is used or not.
1290 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1291 krb5_set_dns_canonicalize_hostname (krb5_context context
, krb5_boolean flag
)
1294 context
->flags
|= KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
;
1296 context
->flags
&= ~KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
;
1300 * Get if the library uses DNS to canonicalize hostnames.
1302 * @param context Kerberos 5 context.
1304 * @return return non zero if the library uses DNS to canonicalize hostnames.
1309 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1310 krb5_get_dns_canonicalize_hostname (krb5_context context
)
1312 return (context
->flags
& KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
) ? 1 : 0;
1316 * Get current offset in time to the KDC.
1318 * @param context Kerberos 5 context.
1319 * @param sec seconds part of offset.
1320 * @param usec micro seconds part of offset.
1322 * @return returns zero
1327 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1328 krb5_get_kdc_sec_offset (krb5_context context
, int32_t *sec
, int32_t *usec
)
1331 *sec
= context
->kdc_sec_offset
;
1333 *usec
= context
->kdc_usec_offset
;
1338 * Set current offset in time to the KDC.
1340 * @param context Kerberos 5 context.
1341 * @param sec seconds part of offset.
1342 * @param usec micro seconds part of offset.
1344 * @return returns zero
1349 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1350 krb5_set_kdc_sec_offset (krb5_context context
, int32_t sec
, int32_t usec
)
1352 context
->kdc_sec_offset
= sec
;
1354 context
->kdc_usec_offset
= usec
;
1359 * Get max time skew allowed.
1361 * @param context Kerberos 5 context.
1363 * @return timeskew in seconds.
1368 KRB5_LIB_FUNCTION
time_t KRB5_LIB_CALL
1369 krb5_get_max_time_skew (krb5_context context
)
1371 return context
->max_skew
;
1375 * Set max time skew allowed.
1377 * @param context Kerberos 5 context.
1378 * @param t timeskew in seconds.
1383 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1384 krb5_set_max_time_skew (krb5_context context
, time_t t
)
1386 context
->max_skew
= t
;
1390 * Init encryption types in len, val with etypes.
1392 * @param context Kerberos 5 context.
1393 * @param pdu_type type of pdu
1394 * @param len output length of val.
1395 * @param val output array of enctypes.
1396 * @param etypes etypes to set val and len to, if NULL, use default enctypes.
1398 * @return Returns 0 to indicate success. Otherwise an kerberos et
1399 * error code is returned, see krb5_get_error_message().
1404 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1405 _krb5_init_etype(krb5_context context
,
1409 const krb5_enctype
*etypes
)
1411 krb5_error_code ret
;
1414 ret
= krb5_get_default_in_tkt_etypes(context
, pdu_type
, val
);
1416 ret
= copy_enctypes(context
, etypes
, val
);
1422 while ((*val
)[*len
] != KRB5_ENCTYPE_NULL
)
1429 * Allow homedir access
1432 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1433 _krb5_homedir_access(krb5_context context
)
1436 return !!(context
->flags
& KRB5_CTX_F_HOMEDIR_ACCESS
);
1441 * Enable and disable home directory access on either the global state
1442 * or the krb5_context state. By calling krb5_set_home_dir_access()
1443 * with context set to NULL, the global state is configured otherwise
1444 * the state for the krb5_context is modified.
1446 * For home directory access to be allowed, both the global state and
1447 * the krb5_context state have to be allowed.
1449 * @param context a Kerberos 5 context or NULL
1450 * @param allow allow if TRUE home directory
1451 * @return the old value
1456 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1457 krb5_set_home_dir_access(krb5_context context
, krb5_boolean allow
)
1459 krb5_boolean old
= _krb5_homedir_access(context
);
1463 context
->flags
|= KRB5_CTX_F_HOMEDIR_ACCESS
;
1465 context
->flags
&= ~KRB5_CTX_F_HOMEDIR_ACCESS
;
1466 heim_context_set_homedir_access(context
->hcontext
, allow
? 1 : 0);