Heimdal Kerberos 5 library(3) | HeimdalKerberos5library | Heimdal Kerberos 5 library(3) |
NAME
Heimdal Kerberos 5 library -Functions
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_et_list (krb5_context context, void(*func)(struct et_list **))
Detailed Description
Function Documentation
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_et_list (krb5_context context, void(*)(struct et_list **) func)
Add a specified list of error messages to the et list in context. Call func (probably a comerr-generated function) with a pointer to the current et_list.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_extra_addresses (krb5_context context, krb5_addresses * addresses)
Add extra address to the address list that the library will add to the client's address list when communicating with the KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_ignore_addresses (krb5_context context, krb5_addresses * addresses)
Add extra addresses to ignore when fetching addresses from the underlaying operating system.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_compare_creds (krb5_context context, krb5_flags whichfields, const krb5_creds * mcreds, const krb5_creds * creds)
Return TRUE if `mcreds' and `creds' are equal (`whichfields' determines what equal means).The following flags, set in whichfields affects the comparison:
- •
- KRB5_TC_MATCH_SRV_NAMEONLY Consider all realms equal when comparing the service principal.
- •
- KRB5_TC_MATCH_KEYTYPE Compare enctypes.
- •
- KRB5_TC_MATCH_FLAGS_EXACT Make sure that the ticket flags are identical.
- •
- KRB5_TC_MATCH_FLAGS Make sure that all ticket flags set in mcreds are also present in creds .
- •
- KRB5_TC_MATCH_TIMES_EXACT Compares the ticket times exactly.
- •
- KRB5_TC_MATCH_TIMES Compares only the expiration times of the creds.
- •
- KRB5_TC_MATCH_AUTHDATA Compares the authdata fields.
- •
- KRB5_TC_MATCH_2ND_TKT Compares the second tickets (used by user-to-user authentication).
- •
- KRB5_TC_MATCH_IS_SKEY Compares the existance of the second ticket.
Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_context (krb5_context context, krb5_context * out)
Make a copy for the Kerberos 5 context, the new krb5_context shoud be freed with krb5_free_context().Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds (krb5_context context, const krb5_creds * incred, krb5_creds ** outcred)
Copy krb5_creds.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds_contents (krb5_context context, const krb5_creds * incred, krb5_creds * c)
Copy content of krb5_creds.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_data (krb5_context context, const krb5_data * indata, krb5_data ** outdata)
Copy the data into a newly allocated krb5_data.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_host_realm (krb5_context context, const krb5_realm * from, krb5_realm ** to)
Copy the list of realms from `from' to `to'.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_ticket (krb5_context context, const krb5_ticket * from, krb5_ticket ** to)
Copy ticket and contentParameters:
Returns:
KRB5_LIB_FUNCTION unsigned long KRB5_LIB_CALL krb5_creds_get_ticket_flags (krb5_creds * creds)
Returns the ticket flags for the credentials in creds. See also krb5_ticket_get_flags().Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_alloc (krb5_data * p, int len)
Allocate data of and krb5_data.Parameters:
Returns:
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_cmp (const krb5_data * data1, const krb5_data * data2)
Compare to data.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_copy (krb5_data * p, const void * data, size_t len)
Copy the data of len into the krb5_data.Parameters:
Returns:
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_ct_cmp (const krb5_data * data1, const krb5_data * data2)
Compare to data not exposing timing information from the checksum dataParameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_free (krb5_data * p)
Free the content of krb5_data structure, its ok to free a zeroed structure (with memset() or krb5_data_zero()). When done, the structure will be zeroed. The same function is called krb5_free_data_contents() in MIT Kerberos.Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_realloc (krb5_data * p, int len)
Grow (or shrink) the content of krb5_data to a new size.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_zero (krb5_data * p)
Reset the (potentially uninitalized) krb5_data structure.Parameters:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_config_files (char ** filenames)
Free a list of configuration files.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_context (krb5_context context)
Frees the krb5_context allocated by krb5_init_context().Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_cred_contents (krb5_context context, krb5_creds * c)
Free content of krb5_creds.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_creds (krb5_context context, krb5_creds * c)
Free krb5_creds.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_data (krb5_context context, krb5_data * p)
Free krb5_data (and its content).Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_ticket (krb5_context context, krb5_ticket * ticket)
Free ticket and contentParameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_default_config_files (char *** pfilenames)
Get the global configuration list.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_default_in_tkt_etypes (krb5_context context, krb5_pdu pdu_type, krb5_enctype ** etypes)
Get the default encryption types that will be use in communcation with the KDC, clients and servers.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_dns_canonicalize_hostname (krb5_context context)
Get if the library uses DNS to canonicalize hostnames.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_extra_addresses (krb5_context context, krb5_addresses * addresses)
Get extra address to the address list that the library will add to the client's address list when communicating with the KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_fcache_version (krb5_context context, int * version)
Get version of fcache that the library should use.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_ignore_addresses (krb5_context context, krb5_addresses * addresses)
Get extra addresses to ignore when fetching addresses from the underlaying operating system.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_kdc_sec_offset (krb5_context context, int32_t * sec, int32_t * usec)
Get current offset in time to the KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_get_max_time_skew (krb5_context context)
Get max time skew allowed.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_use_admin_kdc (krb5_context context)
Make the kerberos library default to the admin KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_context (krb5_context * context)
Initializes the context structure and reads the configuration file /etc/krb5.conf. The structure should be freed by calling krb5_free_context() when it is no longer being used.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_ets (krb5_context context)
Init the built-in ets in the Kerberos library.Parameters:
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_is_thread_safe (void)
Runtime check if the Kerberos library was complied with thread support.Returns:
KRB5_LIB_FUNCTION const krb5_enctype* KRB5_LIB_CALL krb5_kerberos_enctypes (krb5_context context)
Returns the list of Kerberos encryption types sorted in order of most preferred to least preferred encryption type. Note that some encryption types might be disabled, so you need to check with krb5_enctype_valid() before using the encryption type.Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_krbhst_get_addrinfo (krb5_context context, krb5_krbhst_info * host, struct addrinfo ** ai)
Return an `struct addrinfo *' for a KDC host.Returns an the struct addrinfo in in that corresponds to the information in `host'. free:ing is handled by krb5_krbhst_free, so the returned ai must not be released.
First try this as an IP address, this allows us to add a dot at the end to stop using the search domains.
If the hostname contains a dot, assumes it's a FQDN and don't use search domains since that might be painfully slow when machine is disconnected from that network.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_prepend_config_files_default (const char * filelist, char *** pfilenames)
Prepend the filename to the global configuration list.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_config_files (krb5_context context, char ** filenames)
Reinit the context from a new set of filenames.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_default_in_tkt_etypes (krb5_context context, const krb5_enctype * etypes)
Set the default encryption types that will be use in communcation with the KDC, clients and servers.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)
Set if the library should use DNS to canonicalize hostnames.Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_extra_addresses (krb5_context context, const krb5_addresses * addresses)
Set extra address to the address list that the library will add to the client's address list when communicating with the KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_fcache_version (krb5_context context, int version)
Set version of fcache that the library should use.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_set_home_dir_access (krb5_context context, krb5_boolean allow)
Enable and disable home directory access on either the global state or the krb5_context state. By calling krb5_set_home_dir_access() with context set to NULL, the global state is configured otherwise the state for the krb5_context is modified.For home directory access to be allowed, both the global state and the krb5_context state have to be allowed.
Administrator (root user), never uses the home directory.
Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_ignore_addresses (krb5_context context, const krb5_addresses * addresses)
Set extra addresses to ignore when fetching addresses from the underlaying operating system.Parameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_kdc_sec_offset (krb5_context context, int32_t sec, int32_t usec)
Set current offset in time to the KDC.Parameters:
Returns:
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_max_time_skew (krb5_context context, time_t t)
Set max time skew allowed.Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_password (krb5_context context, krb5_creds * creds, const char * newpw, krb5_principal targprinc, int * result_code, krb5_data * result_code_string, krb5_data * result_string)
Change password using creds.Parameters:
Returns:
@
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_real_time (krb5_context context, krb5_timestamp sec, int32_t usec)
Set the absolute time that the caller knows the kdc has so the kerberos library can calculate the relative diffrence beteen the KDC time and local system time.Parameters:
Returns:
If the caller passes in a negative usec, its assumed to be unknown and the function will use the current time usec.
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)
Make the kerberos library default to the admin KDC.Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_authorization_data_type (krb5_context context, krb5_ticket * ticket, int type, krb5_data * data)
Extract the authorization data type of type from the ticket. Store the field in data. This function is to use for kerberos applications.Parameters:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_client (krb5_context context, const krb5_ticket * ticket, krb5_principal * client)
Return client principal in ticketParameters:
Returns:
KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_ticket_get_endtime (krb5_context context, const krb5_ticket * ticket)
Return end time of ticketParameters:
Returns:
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_server (krb5_context context, const krb5_ticket * ticket, krb5_principal * server)
Return server principal in ticketParameters:
Returns:
11 Jan 2012 | Version 1.5.2 |