LIBRARY

Kerberos 5 Library (libkrb5, -lkrb5)

SYNOPSIS

In krb5.h

struct krb5_context;

Ft krb5_error_code Fo krb5_init_context Fa krb5_context *context Fc Ft void Fo krb5_free_context Fa krb5_context context Fc Ft void Fo krb5_init_ets Fa krb5_context context Fc Ft krb5_error_code Fo krb5_add_et_list Fa krb5_context context Fa void (*func)(struct et_list **) Fc Ft krb5_error_code Fo krb5_add_extra_addresses Fa krb5_context context Fa krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_set_extra_addresses Fa krb5_context context Fa const krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_get_extra_addresses Fa krb5_context context Fa krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_add_ignore_addresses Fa krb5_context context Fa krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_set_ignore_addresses Fa krb5_context context Fa const krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_get_ignore_addresses Fa krb5_context context Fa krb5_addresses *addresses Fc Ft krb5_error_code Fo krb5_set_fcache_version Fa krb5_context context Fa int version Fc Ft krb5_error_code Fo krb5_get_fcache_version Fa krb5_context context Fa int *version Fc Ft void Fo krb5_set_dns_canonize_hostname Fa krb5_context context Fa krb5_boolean flag Fc Ft krb5_boolean Fo krb5_get_dns_canonize_hostname Fa krb5_context context Fc Ft krb5_error_code Fo krb5_get_kdc_sec_offset Fa krb5_context context Fa int32_t *sec Fa int32_t *usec Fc Ft krb5_error_code Fo krb5_set_config_files Fa krb5_context context Fa char **filenames Fc Ft krb5_error_code Fo krb5_prepend_config_files Fa const char *filelist Fa char **pq Fa char ***ret_pp Fc Ft krb5_error_code Fo krb5_prepend_config_files_default Fa const char *filelist Fa char ***pfilenames Fc Ft krb5_error_code Fo krb5_get_default_config_files Fa char ***pfilenames Fc Ft void Fo krb5_free_config_files Fa char **filenames Fc Ft void Fo krb5_set_use_admin_kdc Fa krb5_context context Fa krb5_boolean flag Fc Ft krb5_boolean Fo krb5_get_use_admin_kdc Fa krb5_context context Fc Ft time_t Fo krb5_get_max_time_skew Fa krb5_context context Fc Ft krb5_error_code Fo krb5_set_max_time_skew Fa krb5_context context Fa time_t time Fc

DESCRIPTION

The Fn krb5_init_context function initializes the Fa context structure and reads the configuration file /etc/krb5.conf

The structure should be freed by calling Fn krb5_free_context when it is no longer being used.

Fn krb5_init_context returns 0 to indicate success. Otherwise an errno code is returned. Failure means either that something bad happened during initialization (typically Bq ENOMEM ) or that Kerberos should not be used Bq ENXIO .

Fn krb5_init_ets adds all com_err3 libs to Fa context . This is done by Fn krb5_init_context .

Fn krb5_add_et_list adds a com_err3 error-code handler Fa func to the specified Fa context . The error handler must generated by the the re-rentrant version of the compile_et1 program. Fn krb5_add_extra_addresses add a list of addresses that should be added when requesting tickets.

Fn krb5_add_ignore_addresses add a list of addresses that should be ignored when requesting tickets.

Fn krb5_get_extra_addresses get the list of addresses that should be added when requesting tickets.

Fn krb5_get_ignore_addresses get the list of addresses that should be ignored when requesting tickets.

Fn krb5_set_ignore_addresses set the list of addresses that should be ignored when requesting tickets.

Fn krb5_set_extra_addresses set the list of addresses that should be added when requesting tickets.

Fn krb5_set_fcache_version sets the version of file credentials caches that should be used.

Fn krb5_get_fcache_version gets the version of file credentials caches that should be used.

Fn krb5_set_dns_canonize_hostname sets if the context is configured to canonicalize hostnames using DNS.

Fn krb5_get_dns_canonize_hostname returns if the context is configured to canonicalize hostnames using DNS.

Fn krb5_get_kdc_sec_offset returns the offset between the localtime and the KDC's time. Fa sec and Fa usec are both optional argument and NULL can be passed in.

Fn krb5_set_config_files set the list of configuration files to use and re-initialize the configuration from the files.

Fn krb5_prepend_config_files parse the Fa filelist and prepend the result to the already existing list Fa pq The result is returned in Fa ret_pp and should be freed with Fn krb5_free_config_files .

Fn krb5_prepend_config_files_default parse the Fa filelist and append that to the default list of configuration files.

Fn krb5_get_default_config_files get a list of default configuration files.

Fn krb5_free_config_files free a list of configuration files returned by Fn krb5_get_default_config_files , Fn krb5_prepend_config_files_default , or Fn krb5_prepend_config_files .

Fn krb5_set_use_admin_kdc sets if all KDC requests should go admin KDC.

Fn krb5_get_use_admin_kdc gets if all KDC requests should go admin KDC.

Fn krb5_get_max_time_skew and Fn krb5_set_max_time_skew get and sets the maximum allowed time skew between client and server.