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 #include "krb5_locl.h"
40 #define INIT_FIELD(C, T, E, D, F) \
41 (C)->E = krb5_config_get_ ## T ## _default ((C), NULL, (D), \
42 "libdefaults", F, NULL)
44 #define INIT_FLAG(C, O, V, D, F) \
46 if (krb5_config_get_bool_default((C), NULL, (D),"libdefaults", F, NULL)) { \
52 * Set the list of etypes `ret_etypes' from the configuration variable
56 static krb5_error_code
57 set_etypes (krb5_context context
,
59 krb5_enctype
**ret_enctypes
)
62 krb5_enctype
*etypes
= NULL
;
64 etypes_str
= krb5_config_get_strings(context
, NULL
, "libdefaults",
68 for(i
= 0; etypes_str
[i
]; i
++);
69 etypes
= malloc((i
+1) * sizeof(*etypes
));
71 krb5_config_free_strings (etypes_str
);
72 return krb5_enomem(context
);
74 for(j
= 0, k
= 0; j
< i
; j
++) {
76 if(krb5_string_to_enctype(context
, etypes_str
[j
], &e
) != 0)
78 if (krb5_enctype_valid(context
, e
) != 0)
82 etypes
[k
] = ETYPE_NULL
;
83 krb5_config_free_strings(etypes_str
);
85 *ret_enctypes
= etypes
;
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
)
99 krb5_enctype
*tmptypes
;
101 INIT_FIELD(context
, time
, max_skew
, 5 * 60, "clockskew");
102 INIT_FIELD(context
, time
, kdc_timeout
, 30, "kdc_timeout");
103 INIT_FIELD(context
, time
, host_timeout
, 3, "host_timeout");
104 INIT_FIELD(context
, int, max_retries
, 3, "max_retries");
106 INIT_FIELD(context
, string
, http_proxy
, NULL
, "http_proxy");
108 ret
= krb5_config_get_bool_default(context
, NULL
, FALSE
,
110 "allow_weak_crypto", NULL
);
112 krb5_enctype_enable(context
, ETYPE_DES_CBC_CRC
);
113 krb5_enctype_enable(context
, ETYPE_DES_CBC_MD4
);
114 krb5_enctype_enable(context
, ETYPE_DES_CBC_MD5
);
115 krb5_enctype_enable(context
, ETYPE_DES_CBC_NONE
);
116 krb5_enctype_enable(context
, ETYPE_DES_CFB64_NONE
);
117 krb5_enctype_enable(context
, ETYPE_DES_PCBC_NONE
);
120 ret
= set_etypes (context
, "default_etypes", &tmptypes
);
123 free(context
->etypes
);
124 context
->etypes
= tmptypes
;
126 ret
= set_etypes (context
, "default_etypes_des", &tmptypes
);
129 free(context
->etypes_des
);
130 context
->etypes_des
= tmptypes
;
132 ret
= set_etypes (context
, "default_as_etypes", &tmptypes
);
135 free(context
->as_etypes
);
136 context
->as_etypes
= tmptypes
;
138 ret
= set_etypes (context
, "default_tgs_etypes", &tmptypes
);
141 free(context
->tgs_etypes
);
142 context
->tgs_etypes
= tmptypes
;
144 ret
= set_etypes (context
, "permitted_enctypes", &tmptypes
);
147 free(context
->permitted_enctypes
);
148 context
->permitted_enctypes
= tmptypes
;
150 /* default keytab name */
153 tmp
= getenv("KRB5_KTNAME");
155 context
->default_keytab
= tmp
;
157 INIT_FIELD(context
, string
, default_keytab
,
158 KEYTAB_DEFAULT
, "default_keytab_name");
160 INIT_FIELD(context
, string
, default_keytab_modify
,
161 NULL
, "default_keytab_modify_name");
163 INIT_FIELD(context
, string
, time_fmt
,
164 "%Y-%m-%dT%H:%M:%S", "time_format");
166 INIT_FIELD(context
, string
, date_fmt
,
167 "%Y-%m-%d", "date_format");
169 INIT_FIELD(context
, bool, log_utc
,
174 /* init dns-proxy slime */
175 tmp
= krb5_config_get_string(context
, NULL
, "libdefaults",
178 roken_gethostby_setup(context
->http_proxy
, tmp
);
179 krb5_free_host_realm (context
, context
->default_realms
);
180 context
->default_realms
= NULL
;
183 krb5_addresses addresses
;
186 krb5_set_extra_addresses(context
, NULL
);
187 adr
= krb5_config_get_strings(context
, NULL
,
191 memset(&addresses
, 0, sizeof(addresses
));
192 for(a
= adr
; a
&& *a
; a
++) {
193 ret
= krb5_parse_address(context
, *a
, &addresses
);
195 krb5_add_extra_addresses(context
, &addresses
);
196 krb5_free_addresses(context
, &addresses
);
199 krb5_config_free_strings(adr
);
201 krb5_set_ignore_addresses(context
, NULL
);
202 adr
= krb5_config_get_strings(context
, NULL
,
206 memset(&addresses
, 0, sizeof(addresses
));
207 for(a
= adr
; a
&& *a
; a
++) {
208 ret
= krb5_parse_address(context
, *a
, &addresses
);
210 krb5_add_ignore_addresses(context
, &addresses
);
211 krb5_free_addresses(context
, &addresses
);
214 krb5_config_free_strings(adr
);
217 INIT_FIELD(context
, bool, scan_interfaces
, TRUE
, "scan_interfaces");
218 INIT_FIELD(context
, int, fcache_vno
, 0, "fcache_version");
219 /* prefer dns_lookup_kdc over srv_lookup. */
220 INIT_FIELD(context
, bool, srv_lookup
, TRUE
, "srv_lookup");
221 INIT_FIELD(context
, bool, srv_lookup
, context
->srv_lookup
, "dns_lookup_kdc");
222 INIT_FIELD(context
, int, large_msg_size
, 1400, "large_message_size");
223 INIT_FIELD(context
, int, max_msg_size
, 1000 * 1024, "maximum_message_size");
224 INIT_FLAG(context
, flags
, KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
, TRUE
, "dns_canonicalize_hostname");
225 INIT_FLAG(context
, flags
, KRB5_CTX_F_CHECK_PAC
, TRUE
, "check_pac");
227 if (context
->default_cc_name
)
228 free(context
->default_cc_name
);
229 context
->default_cc_name
= NULL
;
230 context
->default_cc_name_set
= 0;
232 s
= krb5_config_get_strings(context
, NULL
, "logging", "krb5", NULL
);
236 if (context
->debug_dest
)
237 krb5_closelog(context
, context
->debug_dest
);
239 krb5_initlog(context
, "libkrb5", &context
->debug_dest
);
241 krb5_addlog_dest(context
, context
->debug_dest
, *p
);
242 krb5_config_free_strings(s
);
245 tmp
= krb5_config_get_string(context
, NULL
, "libdefaults",
246 "check-rd-req-server", NULL
);
247 if (tmp
== NULL
&& !issuid())
248 tmp
= getenv("KRB5_CHECK_RD_REQ_SERVER");
250 if (strcasecmp(tmp
, "ignore") == 0)
251 context
->flags
|= KRB5_CTX_F_RD_REQ_IGNORE
;
253 ret
= krb5_config_get_bool_default(context
, NULL
, TRUE
,
255 "fcache_strict_checking", NULL
);
257 context
->flags
|= KRB5_CTX_F_FCACHE_STRICT_CHECKING
;
262 static krb5_error_code
263 cc_ops_register(krb5_context context
)
265 context
->cc_ops
= NULL
;
266 context
->num_cc_ops
= 0;
268 #ifndef KCM_IS_API_CACHE
269 krb5_cc_register(context
, &krb5_acc_ops
, TRUE
);
271 krb5_cc_register(context
, &krb5_fcc_ops
, TRUE
);
272 krb5_cc_register(context
, &krb5_dcc_ops
, TRUE
);
273 krb5_cc_register(context
, &krb5_mcc_ops
, TRUE
);
275 krb5_cc_register(context
, &krb5_scc_ops
, TRUE
);
278 #ifdef KCM_IS_API_CACHE
279 krb5_cc_register(context
, &krb5_akcm_ops
, TRUE
);
281 krb5_cc_register(context
, &krb5_kcm_ops
, TRUE
);
283 _krb5_load_ccache_plugins(context
);
287 static krb5_error_code
288 cc_ops_copy(krb5_context context
, const krb5_context src_context
)
290 const krb5_cc_ops
**cc_ops
;
292 context
->cc_ops
= NULL
;
293 context
->num_cc_ops
= 0;
295 if (src_context
->num_cc_ops
== 0)
298 cc_ops
= malloc(sizeof(cc_ops
[0]) * src_context
->num_cc_ops
);
299 if (cc_ops
== NULL
) {
300 krb5_set_error_message(context
, KRB5_CC_NOMEM
,
301 N_("malloc: out of memory", ""));
302 return KRB5_CC_NOMEM
;
305 memcpy(rk_UNCONST(cc_ops
), src_context
->cc_ops
,
306 sizeof(cc_ops
[0]) * src_context
->num_cc_ops
);
307 context
->cc_ops
= cc_ops
;
308 context
->num_cc_ops
= src_context
->num_cc_ops
;
313 static krb5_error_code
314 kt_ops_register(krb5_context context
)
316 context
->num_kt_types
= 0;
317 context
->kt_types
= NULL
;
319 krb5_kt_register (context
, &krb5_fkt_ops
);
320 krb5_kt_register (context
, &krb5_wrfkt_ops
);
321 krb5_kt_register (context
, &krb5_javakt_ops
);
322 krb5_kt_register (context
, &krb5_mkt_ops
);
323 #ifndef HEIMDAL_SMALLER
324 krb5_kt_register (context
, &krb5_akf_ops
);
326 krb5_kt_register (context
, &krb5_any_ops
);
330 static krb5_error_code
331 kt_ops_copy(krb5_context context
, const krb5_context src_context
)
333 context
->num_kt_types
= 0;
334 context
->kt_types
= NULL
;
336 if (src_context
->num_kt_types
== 0)
339 context
->kt_types
= malloc(sizeof(context
->kt_types
[0]) * src_context
->num_kt_types
);
340 if (context
->kt_types
== NULL
)
341 return krb5_enomem(context
);
343 context
->num_kt_types
= src_context
->num_kt_types
;
344 memcpy(context
->kt_types
, src_context
->kt_types
,
345 sizeof(context
->kt_types
[0]) * src_context
->num_kt_types
);
350 static const char *sysplugin_dirs
[] = {
351 LIBDIR
"/plugin/krb5",
353 "/Library/KerberosPlugins/KerberosFrameworkPlugins",
354 "/System/Library/KerberosPlugins/KerberosFrameworkPlugins",
360 init_context_once(void *ctx
)
362 krb5_context context
= ctx
;
365 dirs
= krb5_config_get_strings(context
, NULL
, "libdefaults",
368 dirs
= rk_UNCONST(sysplugin_dirs
);
370 _krb5_load_plugins(context
, "krb5", (const char **)dirs
);
372 if (dirs
!= rk_UNCONST(sysplugin_dirs
))
373 krb5_config_free_strings(dirs
);
375 bindtextdomain(HEIMDAL_TEXTDOMAIN
, HEIMDAL_LOCALEDIR
);
380 * Initializes the context structure and reads the configuration file
381 * /etc/krb5.conf. The structure should be freed by calling
382 * krb5_free_context() when it is no longer being used.
384 * @param context pointer to returned context
386 * @return Returns 0 to indicate success. Otherwise an errno code is
387 * returned. Failure means either that something bad happened during
388 * initialization (typically ENOMEM) or that Kerberos should not be
394 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
395 krb5_init_context(krb5_context
*context
)
397 static heim_base_once_t init_context
= HEIM_BASE_ONCE_INIT
;
404 p
= calloc(1, sizeof(*p
));
408 p
->mutex
= malloc(sizeof(HEIMDAL_MUTEX
));
409 if (p
->mutex
== NULL
) {
413 HEIMDAL_MUTEX_init(p
->mutex
);
415 p
->flags
|= KRB5_CTX_F_HOMEDIR_ACCESS
;
417 ret
= krb5_get_default_config_files(&files
);
420 ret
= krb5_set_config_files(p
, files
);
421 krb5_free_config_files(files
);
425 /* done enough to load plugins */
426 heim_base_once_f(&init_context
, p
, init_context_once
);
428 /* init error tables */
434 ret
= hx509_context_init(&p
->hx509ctx
);
439 p
->flags
|= KRB5_CTX_F_SOCKETS_INITIALIZED
;
443 krb5_free_context(p
);
450 #ifndef HEIMDAL_SMALLER
452 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
453 krb5_get_permitted_enctypes(krb5_context context
,
454 krb5_enctype
**etypes
)
456 return krb5_get_default_in_tkt_etypes(context
, KRB5_PDU_NONE
, etypes
);
463 static krb5_error_code
464 copy_etypes (krb5_context context
,
465 krb5_enctype
*enctypes
,
466 krb5_enctype
**ret_enctypes
)
470 for (i
= 0; enctypes
[i
]; i
++)
474 *ret_enctypes
= malloc(sizeof(ret_enctypes
[0]) * i
);
475 if (*ret_enctypes
== NULL
)
476 return krb5_enomem(context
);
477 memcpy(*ret_enctypes
, enctypes
, sizeof(ret_enctypes
[0]) * i
);
482 * Make a copy for the Kerberos 5 context, the new krb5_context shoud
483 * be freed with krb5_free_context().
485 * @param context the Kerberos context to copy
486 * @param out the copy of the Kerberos, set to NULL error.
488 * @return Returns 0 to indicate success. Otherwise an kerberos et
489 * error code is returned, see krb5_get_error_message().
494 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
495 krb5_copy_context(krb5_context context
, krb5_context
*out
)
502 p
= calloc(1, sizeof(*p
));
504 return krb5_enomem(context
);
506 p
->mutex
= malloc(sizeof(HEIMDAL_MUTEX
));
507 if (p
->mutex
== NULL
) {
509 return krb5_enomem(context
);
511 HEIMDAL_MUTEX_init(p
->mutex
);
514 if (context
->default_cc_name
)
515 p
->default_cc_name
= strdup(context
->default_cc_name
);
516 if (context
->default_cc_name_env
)
517 p
->default_cc_name_env
= strdup(context
->default_cc_name_env
);
519 if (context
->etypes
) {
520 ret
= copy_etypes(context
, context
->etypes
, &p
->etypes
);
524 if (context
->etypes_des
) {
525 ret
= copy_etypes(context
, context
->etypes_des
, &p
->etypes_des
);
530 if (context
->default_realms
) {
531 ret
= krb5_copy_host_realm(context
,
532 context
->default_realms
, &p
->default_realms
);
537 ret
= _krb5_config_copy(context
, context
->cf
, &p
->cf
);
541 /* XXX should copy */
544 cc_ops_copy(p
, context
);
545 kt_ops_copy(p
, context
);
548 if(context
->warn_dest
!= NULL
)
550 if(context
->debug_dest
!= NULL
)
554 ret
= krb5_set_extra_addresses(p
, context
->extra_addresses
);
557 ret
= krb5_set_extra_addresses(p
, context
->ignore_addresses
);
561 ret
= _krb5_copy_send_to_kdc_func(p
, context
);
570 krb5_free_context(p
);
577 * Frees the krb5_context allocated by krb5_init_context().
579 * @param context context to be freed.
584 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
585 krb5_free_context(krb5_context context
)
587 if (context
->default_cc_name
)
588 free(context
->default_cc_name
);
589 if (context
->default_cc_name_env
)
590 free(context
->default_cc_name_env
);
591 free(context
->etypes
);
592 free(context
->etypes_des
);
593 krb5_free_host_realm (context
, context
->default_realms
);
594 krb5_config_file_free (context
, context
->cf
);
595 free_error_table (context
->et_list
);
596 free(rk_UNCONST(context
->cc_ops
));
597 free(context
->kt_types
);
598 krb5_clear_error_message(context
);
599 if(context
->warn_dest
!= NULL
)
600 krb5_closelog(context
, context
->warn_dest
);
601 if(context
->debug_dest
!= NULL
)
602 krb5_closelog(context
, context
->debug_dest
);
603 krb5_set_extra_addresses(context
, NULL
);
604 krb5_set_ignore_addresses(context
, NULL
);
605 krb5_set_send_to_kdc_func(context
, NULL
, NULL
);
608 if (context
->hx509ctx
)
609 hx509_context_free(&context
->hx509ctx
);
612 HEIMDAL_MUTEX_destroy(context
->mutex
);
613 free(context
->mutex
);
614 if (context
->flags
& KRB5_CTX_F_SOCKETS_INITIALIZED
) {
618 memset(context
, 0, sizeof(*context
));
623 * Reinit the context from a new set of filenames.
625 * @param context context to add configuration too.
626 * @param filenames array of filenames, end of list is indicated with a NULL filename.
628 * @return Returns 0 to indicate success. Otherwise an kerberos et
629 * error code is returned, see krb5_get_error_message().
634 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
635 krb5_set_config_files(krb5_context context
, char **filenames
)
638 krb5_config_binding
*tmp
= NULL
;
639 while(filenames
!= NULL
&& *filenames
!= NULL
&& **filenames
!= '\0') {
640 ret
= krb5_config_parse_file_multi(context
, *filenames
, &tmp
);
641 if(ret
!= 0 && ret
!= ENOENT
&& ret
!= EACCES
&& ret
!= EPERM
) {
642 krb5_config_file_free(context
, tmp
);
648 /* with this enabled and if there are no config files, Kerberos is
649 considererd disabled */
655 _krb5_load_config_from_registry(context
, &tmp
);
658 krb5_config_file_free(context
, context
->cf
);
660 ret
= init_context_from_config_file(context
);
664 static krb5_error_code
665 add_file(char ***pfilenames
, int *len
, char *file
)
667 char **pp
= *pfilenames
;
670 for(i
= 0; i
< *len
; i
++) {
671 if(strcmp(pp
[i
], file
) == 0) {
677 pp
= realloc(*pfilenames
, (*len
+ 2) * sizeof(*pp
));
691 * `pq' isn't free, it's up the the caller
694 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
695 krb5_prepend_config_files(const char *filelist
, char **pq
, char ***ret_pp
)
710 l
= strsep_copy(&q
, PATH_SEP
, NULL
, 0);
715 krb5_free_config_files(pp
);
718 (void)strsep_copy(&p
, PATH_SEP
, fn
, l
+ 1);
719 ret
= add_file(&pp
, &len
, fn
);
721 krb5_free_config_files(pp
);
729 for (i
= 0; pq
[i
] != NULL
; i
++) {
732 krb5_free_config_files(pp
);
735 ret
= add_file(&pp
, &len
, fn
);
737 krb5_free_config_files(pp
);
748 * Prepend the filename to the global configuration list.
750 * @param filelist a filename to add to the default list of filename
751 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
753 * @return Returns 0 to indicate success. Otherwise an kerberos et
754 * error code is returned, see krb5_get_error_message().
759 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
760 krb5_prepend_config_files_default(const char *filelist
, char ***pfilenames
)
763 char **defpp
, **pp
= NULL
;
765 ret
= krb5_get_default_config_files(&defpp
);
769 ret
= krb5_prepend_config_files(filelist
, defpp
, &pp
);
770 krb5_free_config_files(defpp
);
781 * Checks the registry for configuration file location
783 * Kerberos for Windows and other legacy Kerberos applications expect
784 * to find the configuration file location in the
785 * SOFTWARE\MIT\Kerberos registry key under the value "config".
787 KRB5_LIB_FUNCTION
char * KRB5_LIB_CALL
788 _krb5_get_default_config_config_files_from_registry()
790 static const char * KeyName
= "Software\\MIT\\Kerberos";
791 char *config_file
= NULL
;
795 rcode
= RegOpenKeyEx(HKEY_CURRENT_USER
, KeyName
, 0, KEY_READ
, &key
);
796 if (rcode
== ERROR_SUCCESS
) {
797 config_file
= _krb5_parse_reg_value_as_multi_string(NULL
, key
, "config",
798 REG_NONE
, 0, PATH_SEP
);
805 rcode
= RegOpenKeyEx(HKEY_LOCAL_MACHINE
, KeyName
, 0, KEY_READ
, &key
);
806 if (rcode
== ERROR_SUCCESS
) {
807 config_file
= _krb5_parse_reg_value_as_multi_string(NULL
, key
, "config",
808 REG_NONE
, 0, PATH_SEP
);
818 * Get the global configuration list.
820 * @param pfilenames return array of filenames, should be freed with krb5_free_config_files().
822 * @return Returns 0 to indicate success. Otherwise an kerberos et
823 * error code is returned, see krb5_get_error_message().
828 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
829 krb5_get_default_config_files(char ***pfilenames
)
831 const char *files
= NULL
;
833 if (pfilenames
== NULL
)
836 files
= getenv("KRB5_CONFIG");
841 reg_files
= _krb5_get_default_config_config_files_from_registry();
842 if (reg_files
!= NULL
) {
843 krb5_error_code code
;
845 code
= krb5_prepend_config_files(reg_files
, NULL
, pfilenames
);
854 files
= krb5_config_file
;
856 return krb5_prepend_config_files(files
, NULL
, pfilenames
);
860 * Free a list of configuration files.
862 * @param filenames list, terminated with a NULL pointer, to be
863 * freed. NULL is an valid argument.
865 * @return Returns 0 to indicate success. Otherwise an kerberos et
866 * error code is returned, see krb5_get_error_message().
871 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
872 krb5_free_config_files(char **filenames
)
875 for(p
= filenames
; p
&& *p
!= NULL
; p
++)
881 * Returns the list of Kerberos encryption types sorted in order of
882 * most preferred to least preferred encryption type. Note that some
883 * encryption types might be disabled, so you need to check with
884 * krb5_enctype_valid() before using the encryption type.
886 * @return list of enctypes, terminated with ETYPE_NULL. Its a static
887 * array completed into the Kerberos library so the content doesn't
893 KRB5_LIB_FUNCTION
const krb5_enctype
* KRB5_LIB_CALL
894 krb5_kerberos_enctypes(krb5_context context
)
896 static const krb5_enctype p
[] = {
897 ETYPE_AES256_CTS_HMAC_SHA1_96
,
898 ETYPE_AES128_CTS_HMAC_SHA1_96
,
900 ETYPE_ARCFOUR_HMAC_MD5
,
904 static const krb5_enctype weak
[] = {
905 ETYPE_AES256_CTS_HMAC_SHA1_96
,
906 ETYPE_AES128_CTS_HMAC_SHA1_96
,
909 ETYPE_ARCFOUR_HMAC_MD5
,
917 * if the list of enctypes enabled by "allow_weak_crypto"
918 * are valid, then return the former default enctype list
919 * that contained the weak entries.
921 if (krb5_enctype_valid(context
, ETYPE_DES_CBC_CRC
) == 0 &&
922 krb5_enctype_valid(context
, ETYPE_DES_CBC_MD4
) == 0 &&
923 krb5_enctype_valid(context
, ETYPE_DES_CBC_MD5
) == 0 &&
924 krb5_enctype_valid(context
, ETYPE_DES_CBC_NONE
) == 0 &&
925 krb5_enctype_valid(context
, ETYPE_DES_CFB64_NONE
) == 0 &&
926 krb5_enctype_valid(context
, ETYPE_DES_PCBC_NONE
) == 0)
936 static krb5_error_code
937 copy_enctypes(krb5_context context
,
938 const krb5_enctype
*in
,
941 krb5_enctype
*p
= NULL
;
944 for (n
= 0; in
[n
]; n
++)
949 return krb5_enomem(context
);
950 for (n
= 0, m
= 0; in
[n
]; n
++) {
951 if (krb5_enctype_valid(context
, in
[n
]) != 0)
955 p
[m
] = KRB5_ENCTYPE_NULL
;
958 krb5_set_error_message (context
, KRB5_PROG_ETYPE_NOSUPP
,
959 N_("no valid enctype set", ""));
960 return KRB5_PROG_ETYPE_NOSUPP
;
968 * set `etype' to a malloced list of the default enctypes
971 static krb5_error_code
972 default_etypes(krb5_context context
, krb5_enctype
**etype
)
974 const krb5_enctype
*p
= krb5_kerberos_enctypes(context
);
975 return copy_enctypes(context
, p
, etype
);
979 * Set the default encryption types that will be use in communcation
980 * with the KDC, clients and servers.
982 * @param context Kerberos 5 context.
983 * @param etypes Encryption types, array terminated with ETYPE_NULL (0).
985 * @return Returns 0 to indicate success. Otherwise an kerberos et
986 * error code is returned, see krb5_get_error_message().
991 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
992 krb5_set_default_in_tkt_etypes(krb5_context context
,
993 const krb5_enctype
*etypes
)
996 krb5_enctype
*p
= NULL
;
999 ret
= copy_enctypes(context
, etypes
, &p
);
1004 free(context
->etypes
);
1005 context
->etypes
= p
;
1010 * Get the default encryption types that will be use in communcation
1011 * with the KDC, clients and servers.
1013 * @param context Kerberos 5 context.
1014 * @param etypes Encryption types, array terminated with
1015 * ETYPE_NULL(0), caller should free array with krb5_xfree():
1017 * @return Returns 0 to indicate success. Otherwise an kerberos et
1018 * error code is returned, see krb5_get_error_message().
1023 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1024 krb5_get_default_in_tkt_etypes(krb5_context context
,
1026 krb5_enctype
**etypes
)
1028 krb5_enctype
*enctypes
= NULL
;
1029 krb5_error_code ret
;
1032 heim_assert(pdu_type
== KRB5_PDU_AS_REQUEST
||
1033 pdu_type
== KRB5_PDU_TGS_REQUEST
||
1034 pdu_type
== KRB5_PDU_NONE
, "pdu contant not as expected");
1036 if (pdu_type
== KRB5_PDU_AS_REQUEST
&& context
->as_etypes
!= NULL
)
1037 enctypes
= context
->as_etypes
;
1038 else if (pdu_type
== KRB5_PDU_TGS_REQUEST
&& context
->tgs_etypes
!= NULL
)
1039 enctypes
= context
->tgs_etypes
;
1040 else if (context
->etypes
!= NULL
)
1041 enctypes
= context
->etypes
;
1043 if (enctypes
!= NULL
) {
1044 ret
= copy_enctypes(context
, enctypes
, &p
);
1048 ret
= default_etypes(context
, &p
);
1057 * Init the built-in ets in the Kerberos library.
1059 * @param context kerberos context to add the ets too
1064 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1065 krb5_init_ets(krb5_context context
)
1067 if(context
->et_list
== NULL
){
1068 krb5_add_et_list(context
, initialize_krb5_error_table_r
);
1069 krb5_add_et_list(context
, initialize_asn1_error_table_r
);
1070 krb5_add_et_list(context
, initialize_heim_error_table_r
);
1072 krb5_add_et_list(context
, initialize_k524_error_table_r
);
1074 #ifdef COM_ERR_BINDDOMAIN_krb5
1075 bindtextdomain(COM_ERR_BINDDOMAIN_krb5
, HEIMDAL_LOCALEDIR
);
1076 bindtextdomain(COM_ERR_BINDDOMAIN_asn1
, HEIMDAL_LOCALEDIR
);
1077 bindtextdomain(COM_ERR_BINDDOMAIN_heim
, HEIMDAL_LOCALEDIR
);
1078 bindtextdomain(COM_ERR_BINDDOMAIN_k524
, HEIMDAL_LOCALEDIR
);
1082 krb5_add_et_list(context
, initialize_hx_error_table_r
);
1083 #ifdef COM_ERR_BINDDOMAIN_hx
1084 bindtextdomain(COM_ERR_BINDDOMAIN_hx
, HEIMDAL_LOCALEDIR
);
1091 * Make the kerberos library default to the admin KDC.
1093 * @param context Kerberos 5 context.
1094 * @param flag boolean flag to select if the use the admin KDC or not.
1099 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1100 krb5_set_use_admin_kdc (krb5_context context
, krb5_boolean flag
)
1102 context
->use_admin_kdc
= flag
;
1106 * Make the kerberos library default to the admin KDC.
1108 * @param context Kerberos 5 context.
1110 * @return boolean flag to telling the context will use admin KDC as the default KDC.
1115 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1116 krb5_get_use_admin_kdc (krb5_context context
)
1118 return context
->use_admin_kdc
;
1122 * Add 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 add
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_add_extra_addresses(krb5_context context
, krb5_addresses
*addresses
)
1138 if(context
->extra_addresses
)
1139 return krb5_append_addresses(context
,
1140 context
->extra_addresses
, addresses
);
1142 return krb5_set_extra_addresses(context
, addresses
);
1146 * Set extra address to the address list that the library will add to
1147 * the client's address list when communicating with the KDC.
1149 * @param context Kerberos 5 context.
1150 * @param addresses addreses to set
1152 * @return Returns 0 to indicate success. Otherwise an kerberos et
1153 * error code is returned, see krb5_get_error_message().
1158 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1159 krb5_set_extra_addresses(krb5_context context
, const krb5_addresses
*addresses
)
1161 if(context
->extra_addresses
)
1162 krb5_free_addresses(context
, context
->extra_addresses
);
1164 if(addresses
== NULL
) {
1165 if(context
->extra_addresses
!= NULL
) {
1166 free(context
->extra_addresses
);
1167 context
->extra_addresses
= NULL
;
1171 if(context
->extra_addresses
== NULL
) {
1172 context
->extra_addresses
= malloc(sizeof(*context
->extra_addresses
));
1173 if (context
->extra_addresses
== NULL
)
1174 return krb5_enomem(context
);
1176 return krb5_copy_addresses(context
, addresses
, context
->extra_addresses
);
1180 * Get extra address to the address list that the library will add to
1181 * the client's address list when communicating with the KDC.
1183 * @param context Kerberos 5 context.
1184 * @param addresses addreses to set
1186 * @return Returns 0 to indicate success. Otherwise an kerberos et
1187 * error code is returned, see krb5_get_error_message().
1192 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1193 krb5_get_extra_addresses(krb5_context context
, krb5_addresses
*addresses
)
1195 if(context
->extra_addresses
== NULL
) {
1196 memset(addresses
, 0, sizeof(*addresses
));
1199 return krb5_copy_addresses(context
,context
->extra_addresses
, addresses
);
1203 * Add extra addresses to ignore when fetching addresses from the
1204 * underlaying operating system.
1206 * @param context Kerberos 5 context.
1207 * @param addresses addreses to ignore
1209 * @return Returns 0 to indicate success. Otherwise an kerberos et
1210 * error code is returned, see krb5_get_error_message().
1215 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1216 krb5_add_ignore_addresses(krb5_context context
, krb5_addresses
*addresses
)
1219 if(context
->ignore_addresses
)
1220 return krb5_append_addresses(context
,
1221 context
->ignore_addresses
, addresses
);
1223 return krb5_set_ignore_addresses(context
, addresses
);
1227 * Set extra addresses to ignore when fetching addresses from the
1228 * underlaying operating system.
1230 * @param context Kerberos 5 context.
1231 * @param addresses addreses to ignore
1233 * @return Returns 0 to indicate success. Otherwise an kerberos et
1234 * error code is returned, see krb5_get_error_message().
1239 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1240 krb5_set_ignore_addresses(krb5_context context
, const krb5_addresses
*addresses
)
1242 if(context
->ignore_addresses
)
1243 krb5_free_addresses(context
, context
->ignore_addresses
);
1244 if(addresses
== NULL
) {
1245 if(context
->ignore_addresses
!= NULL
) {
1246 free(context
->ignore_addresses
);
1247 context
->ignore_addresses
= NULL
;
1251 if(context
->ignore_addresses
== NULL
) {
1252 context
->ignore_addresses
= malloc(sizeof(*context
->ignore_addresses
));
1253 if (context
->ignore_addresses
== NULL
)
1254 return krb5_enomem(context
);
1256 return krb5_copy_addresses(context
, addresses
, context
->ignore_addresses
);
1260 * Get extra addresses to ignore when fetching addresses from the
1261 * underlaying operating system.
1263 * @param context Kerberos 5 context.
1264 * @param addresses list addreses ignored
1266 * @return Returns 0 to indicate success. Otherwise an kerberos et
1267 * error code is returned, see krb5_get_error_message().
1272 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1273 krb5_get_ignore_addresses(krb5_context context
, krb5_addresses
*addresses
)
1275 if(context
->ignore_addresses
== NULL
) {
1276 memset(addresses
, 0, sizeof(*addresses
));
1279 return krb5_copy_addresses(context
, context
->ignore_addresses
, addresses
);
1283 * Set version of fcache that the library should use.
1285 * @param context Kerberos 5 context.
1286 * @param version version number.
1288 * @return Returns 0 to indicate success. Otherwise an kerberos et
1289 * error code is returned, see krb5_get_error_message().
1294 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1295 krb5_set_fcache_version(krb5_context context
, int version
)
1297 context
->fcache_vno
= version
;
1302 * Get version of fcache that the library should use.
1304 * @param context Kerberos 5 context.
1305 * @param version version number.
1307 * @return Returns 0 to indicate success. Otherwise an kerberos et
1308 * error code is returned, see krb5_get_error_message().
1313 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1314 krb5_get_fcache_version(krb5_context context
, int *version
)
1316 *version
= context
->fcache_vno
;
1321 * Runtime check if the Kerberos library was complied with thread support.
1323 * @return TRUE if the library was compiled with thread support, FALSE if not.
1329 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1330 krb5_is_thread_safe(void)
1332 #ifdef ENABLE_PTHREAD_SUPPORT
1340 * Set if the library should use DNS to canonicalize hostnames.
1342 * @param context Kerberos 5 context.
1343 * @param flag if its dns canonicalizion is used or not.
1348 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1349 krb5_set_dns_canonicalize_hostname (krb5_context context
, krb5_boolean flag
)
1352 context
->flags
|= KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
;
1354 context
->flags
&= ~KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
;
1358 * Get if the library uses DNS to canonicalize hostnames.
1360 * @param context Kerberos 5 context.
1362 * @return return non zero if the library uses DNS to canonicalize hostnames.
1367 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1368 krb5_get_dns_canonicalize_hostname (krb5_context context
)
1370 return (context
->flags
& KRB5_CTX_F_DNS_CANONICALIZE_HOSTNAME
) ? 1 : 0;
1374 * Get current offset in time to the KDC.
1376 * @param context Kerberos 5 context.
1377 * @param sec seconds part of offset.
1378 * @param usec micro seconds part of offset.
1380 * @return returns zero
1385 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1386 krb5_get_kdc_sec_offset (krb5_context context
, int32_t *sec
, int32_t *usec
)
1389 *sec
= context
->kdc_sec_offset
;
1391 *usec
= context
->kdc_usec_offset
;
1396 * Set current offset in time to the KDC.
1398 * @param context Kerberos 5 context.
1399 * @param sec seconds part of offset.
1400 * @param usec micro seconds part of offset.
1402 * @return returns zero
1407 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1408 krb5_set_kdc_sec_offset (krb5_context context
, int32_t sec
, int32_t usec
)
1410 context
->kdc_sec_offset
= sec
;
1412 context
->kdc_usec_offset
= usec
;
1417 * Get max time skew allowed.
1419 * @param context Kerberos 5 context.
1421 * @return timeskew in seconds.
1426 KRB5_LIB_FUNCTION
time_t KRB5_LIB_CALL
1427 krb5_get_max_time_skew (krb5_context context
)
1429 return context
->max_skew
;
1433 * Set max time skew allowed.
1435 * @param context Kerberos 5 context.
1436 * @param t timeskew in seconds.
1441 KRB5_LIB_FUNCTION
void KRB5_LIB_CALL
1442 krb5_set_max_time_skew (krb5_context context
, time_t t
)
1444 context
->max_skew
= t
;
1448 * Init encryption types in len, val with etypes.
1450 * @param context Kerberos 5 context.
1451 * @param pdu_type type of pdu
1452 * @param len output length of val.
1453 * @param val output array of enctypes.
1454 * @param etypes etypes to set val and len to, if NULL, use default enctypes.
1456 * @return Returns 0 to indicate success. Otherwise an kerberos et
1457 * error code is returned, see krb5_get_error_message().
1462 KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
1463 _krb5_init_etype(krb5_context context
,
1467 const krb5_enctype
*etypes
)
1469 krb5_error_code ret
;
1472 ret
= krb5_get_default_in_tkt_etypes(context
, pdu_type
, val
);
1474 ret
= copy_enctypes(context
, etypes
, val
);
1480 while ((*val
)[*len
] != KRB5_ENCTYPE_NULL
)
1487 * Allow homedir accces
1490 static HEIMDAL_MUTEX homedir_mutex
= HEIMDAL_MUTEX_INITIALIZER
;
1491 static krb5_boolean allow_homedir
= TRUE
;
1493 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1494 _krb5_homedir_access(krb5_context context
)
1498 if (context
&& (context
->flags
& KRB5_CTX_F_HOMEDIR_ACCESS
) == 0)
1501 HEIMDAL_MUTEX_lock(&homedir_mutex
);
1502 allow
= allow_homedir
;
1503 HEIMDAL_MUTEX_unlock(&homedir_mutex
);
1508 * Enable and disable home directory access on either the global state
1509 * or the krb5_context state. By calling krb5_set_home_dir_access()
1510 * with context set to NULL, the global state is configured otherwise
1511 * the state for the krb5_context is modified.
1513 * For home directory access to be allowed, both the global state and
1514 * the krb5_context state have to be allowed.
1516 * Administrator (root user), never uses the home directory.
1518 * @param context a Kerberos 5 context or NULL
1519 * @param allow allow if TRUE home directory
1520 * @return the old value
1525 KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
1526 krb5_set_home_dir_access(krb5_context context
, krb5_boolean allow
)
1530 old
= (context
->flags
& KRB5_CTX_F_HOMEDIR_ACCESS
) ? TRUE
: FALSE
;
1532 context
->flags
|= KRB5_CTX_F_HOMEDIR_ACCESS
;
1534 context
->flags
&= ~KRB5_CTX_F_HOMEDIR_ACCESS
;
1536 HEIMDAL_MUTEX_lock(&homedir_mutex
);
1537 old
= allow_homedir
;
1538 allow_homedir
= allow
;
1539 HEIMDAL_MUTEX_unlock(&homedir_mutex
);