| Main index | Section 3 | Options |
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:
context A kerberos context.
func The generated com_err et function.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Add extra address to the address list that the library will add to the client's address list when communicating with the KDC.
Parameters:
context Kerberos 5 context.
addresses addreses to add
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Add extra addresses to ignore when fetching addresses from the underlaying operating system.
Parameters:
context Kerberos 5 context.
addresses addreses to ignore
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
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:
context Kerberos 5 context.
whichfields which fields to compare.
mcreds cred to compare with.
creds cred to compare with.
Returns:
return TRUE if mcred and creds are equal, FALSE if not.
Make a copy for the Kerberos 5 context, the new krb5_context shoud be freed with krb5_free_context().
Parameters:
context the Kerberos context to copy
out the copy of the Kerberos, set to NULL error.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Copy krb5_creds.
Parameters:
context Kerberos 5 context.
incred source credential
outcred destination credential, free with krb5_free_creds().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Copy content of krb5_creds.
Parameters:
context Kerberos 5 context.
incred source credential
c destination credential, free with krb5_free_cred_contents().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Copy the data into a newly allocated krb5_data.
Parameters:
context Kerberos 5 context.
indata the krb5_data data to copy
outdata new krb5_date to copy too. Free with krb5_free_data().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
Copy the list of realms from `from' to `to'.
Parameters:
context Kerberos 5 context.
from list of realms to copy from.
to list of realms to copy to, free list of krb5_free_host_realm().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Copy ticket and content
Parameters:
context a Kerberos 5 context
from ticket to copy
to new copy of ticket, free with krb5_free_ticket()
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Returns the ticket flags for the credentials in creds. See also krb5_ticket_get_flags().
Parameters:
creds credential to get ticket flags from
Returns:
ticket flags
Allocate data of and krb5_data.
Parameters:
p krb5_data to allocate.
len size to allocate.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
Compare to data.
Parameters:
data1 krb5_data to compare
data2 krb5_data to compare
Returns:
return the same way as memcmp(), useful when sorting.
Copy the data of len into the krb5_data.
Parameters:
p krb5_data to copy into.
data data to copy..
len new size.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
Compare to data not exposing timing information from the checksum data
Parameters:
data1 krb5_data to compare
data2 krb5_data to compare
Returns:
returns zero for same data, otherwise non zero.
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:
p krb5_data to free.
Grow (or shrink) the content of krb5_data to a new size.
Parameters:
p krb5_data to free.
len new size.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
Reset the (potentially uninitalized) krb5_data structure.
Parameters:
p krb5_data to reset.
Free a list of configuration files.
Parameters:
filenames list, terminated with a NULL pointer, to be freed. NULL is an valid argument.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Frees the krb5_context allocated by krb5_init_context().
Parameters:
context context to be freed.
Free content of krb5_creds.
Parameters:
context Kerberos 5 context.
c krb5_creds to free.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Free krb5_creds.
Parameters:
context Kerberos 5 context.
c krb5_creds to free.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Free krb5_data (and its content).
Parameters:
context Kerberos 5 context.
p krb5_data to free.
Free ticket and content
Parameters:
context a Kerberos 5 context
ticket ticket to free
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get the global configuration list.
Parameters:
pfilenames return array of filenames, should be freed with krb5_free_config_files().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get the default encryption types that will be use in communcation with the KDC, clients and servers.
Parameters:
context Kerberos 5 context.
etypes Encryption types, array terminated with ETYPE_NULL(0), caller should free array with krb5_xfree():
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get if the library uses DNS to canonicalize hostnames.
Parameters:
context Kerberos 5 context.
Returns:
return non zero if the library uses DNS to canonicalize hostnames.
Get extra address to the address list that the library will add to the client's address list when communicating with the KDC.
Parameters:
context Kerberos 5 context.
addresses addreses to set
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get version of fcache that the library should use.
Parameters:
context Kerberos 5 context.
version version number.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get extra addresses to ignore when fetching addresses from the underlaying operating system.
Parameters:
context Kerberos 5 context.
addresses list addreses ignored
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Get current offset in time to the KDC.
Parameters:
context Kerberos 5 context.
sec seconds part of offset.
usec micro seconds part of offset.
Returns:
returns zero
Get max time skew allowed.
Parameters:
context Kerberos 5 context.
Returns:
timeskew in seconds.
Make the kerberos library default to the admin KDC.
Parameters:
context Kerberos 5 context.
Returns:
boolean flag to telling the context will use admin KDC as the default KDC.
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:
context pointer to returned context
Returns:
Returns 0 to indicate success. Otherwise an errno code is returned. Failure means either that something bad happened during initialization (typically ENOMEM) or that Kerberos should not be used ENXIO.
Init the built-in ets in the Kerberos library.
Parameters:
context kerberos context to add the ets too
Runtime check if the Kerberos library was complied with thread support.
Returns:
TRUE if the library was compiled with thread support, FALSE if not.
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:
list of enctypes, terminated with ETYPE_NULL. Its a static array completed into the Kerberos library so the content doesn't need to be freed.
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.
Prepend the filename to the global configuration list.
Parameters:
filelist a filename to add to the default list of filename
pfilenames return array of filenames, should be freed with krb5_free_config_files().
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Reinit the context from a new set of filenames.
Parameters:
context context to add configuration too.
filenames array of filenames, end of list is indicated with a NULL filename.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Set the default encryption types that will be use in communcation with the KDC, clients and servers.
Parameters:
context Kerberos 5 context.
etypes Encryption types, array terminated with ETYPE_NULL (0).
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Set if the library should use DNS to canonicalize hostnames.
Parameters:
context Kerberos 5 context.
flag if its dns canonicalizion is used or not.
Set extra address to the address list that the library will add to the client's address list when communicating with the KDC.
Parameters:
context Kerberos 5 context.
addresses addreses to set
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Set version of fcache that the library should use.
Parameters:
context Kerberos 5 context.
version version number.
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
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:
context a Kerberos 5 context or NULL
allow allow if TRUE home directory
Returns:
the old value
Set extra addresses to ignore when fetching addresses from the underlaying operating system.
Parameters:
context Kerberos 5 context.
addresses addreses to ignore
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Set current offset in time to the KDC.
Parameters:
context Kerberos 5 context.
sec seconds part of offset.
usec micro seconds part of offset.
Returns:
returns zero
Set max time skew allowed.
Parameters:
context Kerberos 5 context.
t timeskew in seconds.
Change password using creds.
Parameters:
context a Keberos context
creds The initial kadmin/passwd for the principal or an admin principal
newpw The new password to set
targprinc if unset, the default principal is used.
result_code Result code, KRB5_KPASSWD_SUCCESS is when password is changed.
result_code_string binary message from the server, contains at least the result_code.
result_string A message from the kpasswd service or the library in human printable form. The string is NUL terminated.
Returns:
On sucess and *result_code is KRB5_KPASSWD_SUCCESS, the password is changed.
@
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:
context Keberos 5 context.
sec The applications new of 'now' in seconds
usec The applications new of 'now' in micro seconds
Returns:
Kerberos 5 error code, see krb5_get_error_message().
If the caller passes in a negative usec, its assumed to be unknown and the function will use the current time usec.
Make the kerberos library default to the admin KDC.
Parameters:
context Kerberos 5 context.
flag boolean flag to select if the use the admin KDC or not.
Extract the authorization data type of type from the ticket. Store the field in data. This function is to use for kerberos applications.
Parameters:
context a Kerberos 5 context
ticket Kerberos ticket
type type to fetch
data returned data, free with krb5_data_free()
Return client principal in ticket
Parameters:
context a Kerberos 5 context
ticket ticket to copy
client client principal, free with krb5_free_principal()
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
Return end time of ticket
Parameters:
context a Kerberos 5 context
ticket ticket to copy
Returns:
end time of ticket
Return server principal in ticket
Parameters:
context a Kerberos 5 context
ticket ticket to copy
server server principal, free with krb5_free_principal()
Returns:
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
| 11 Jan 2012 | Heimdal Kerberos 5 library (3) | Version 1.5.2 |
| Main index | Section 3 | Options |
Please direct any comments about this manual page service to Ben Bullock. Privacy policy.
| “ | The most horrifying thing about Unix is that, no matter how many times you hit yourself over the head with it, you never quite manage to lose consciousness. It just goes on and on. | ” |
| — Patrick Sobalvarro | ||