freebsd-dev/crypto/heimdal/lib/krb5/krb5.3

.\" Copyright (c) 2001, 2003 - 2006 Kungliga Tekniska H<>gskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: krb5.3 18212 2006-10-03 10:39:35Z lha $
.\"
.Dd May  1, 2006
.Dt KRB5 3
.Os
.Sh NAME
.Nm krb5
.Nd Kerberos 5 library
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Sh DESCRIPTION
These functions constitute the Kerberos 5 library,
.Em libkrb5 .
.Sh LIST OF FUNCTIONS
.sp 2
.nf
.ta \w'krb5_ticket_get_authorization_data_type.3'u+2n +\w'Description goes here'u
\fIName/Page\fP	\fIDescription\fP
.ta \w'krb5_ticket_get_authorization_data_type.3'u+2n +\w'Description goes here'u+6nC
.sp 5p
krb524_convert_creds_kdc.3
krb524_convert_creds_kdc_cache.3
krb5_425_conv_principal.3
krb5_425_conv_principal_ext.3
krb5_524_conv_principal.3
krb5_abort.3
krb5_abortx.3
krb5_acl_match_file.3
krb5_acl_match_string.3
krb5_add_et_list.3
krb5_add_extra_addresses.3
krb5_add_ignore_addresses.3
krb5_addlog_dest.3
krb5_addlog_func.3
krb5_addr2sockaddr.3
krb5_address.3
krb5_address_compare.3
krb5_address_order.3
krb5_address_search.3
krb5_addresses.3
krb5_aname_to_localname.3
krb5_anyaddr.3
krb5_appdefault_boolean.3
krb5_appdefault_string.3
krb5_appdefault_time.3
krb5_append_addresses.3
krb5_auth_con_addflags.3
krb5_auth_con_free.3
krb5_auth_con_genaddrs.3
krb5_auth_con_generatelocalsubkey.3
krb5_auth_con_getaddrs.3
krb5_auth_con_getauthenticator.3
krb5_auth_con_getcksumtype.3
krb5_auth_con_getflags.3
krb5_auth_con_getkey.3
krb5_auth_con_getkeytype.3
krb5_auth_con_getlocalseqnumber.3
krb5_auth_con_getlocalsubkey.3
krb5_auth_con_getrcache.3
krb5_auth_con_getremotesubkey.3
krb5_auth_con_getuserkey.3
krb5_auth_con_init.3
krb5_auth_con_initivector.3
krb5_auth_con_removeflags.3
krb5_auth_con_setaddrs.3
krb5_auth_con_setaddrs_from_fd.3
krb5_auth_con_setcksumtype.3
krb5_auth_con_setflags.3
krb5_auth_con_setivector.3
krb5_auth_con_setkey.3
krb5_auth_con_setkeytype.3
krb5_auth_con_setlocalseqnumber.3
krb5_auth_con_setlocalsubkey.3
krb5_auth_con_setrcache.3
krb5_auth_con_setremoteseqnumber.3
krb5_auth_con_setremotesubkey.3
krb5_auth_con_setuserkey.3
krb5_auth_context.3
krb5_auth_getremoteseqnumber.3
krb5_build_principal.3
krb5_build_principal_ext.3
krb5_build_principal_va.3
krb5_build_principal_va_ext.3
krb5_c_block_size.3
krb5_c_checksum_length.3
krb5_c_decrypt.3
krb5_c_encrypt.3
krb5_c_encrypt_length.3
krb5_c_enctype_compare.3
krb5_c_get_checksum.3
krb5_c_is_coll_proof_cksum.3
krb5_c_is_keyed_cksum.3
krb5_c_make_checksum.3
krb5_c_make_random_key.3
krb5_c_set_checksum.3
krb5_c_valid_cksumtype.3
krb5_c_valid_enctype.3
krb5_c_verify_checksum.3
krb5_cc_cache_end_seq_get.3
krb5_cc_cache_get_first.3
krb5_cc_cache_match.3
krb5_cc_cache_next.3
krb5_cc_close.3
krb5_cc_copy_cache.3
krb5_cc_default.3
krb5_cc_default_name.3
krb5_cc_destroy.3
krb5_cc_end_seq_get.3
krb5_cc_gen_new.3
krb5_cc_get_full_name.3
krb5_cc_get_name.3
krb5_cc_get_ops.3
krb5_cc_get_principal.3
krb5_cc_get_type.3
krb5_cc_get_version.3
krb5_cc_initialize.3
krb5_cc_new_unique.3
krb5_cc_next_cred.3
krb5_cc_register.3
krb5_cc_remove_cred.3
krb5_cc_resolve.3
krb5_cc_retrieve_cred.3
krb5_cc_set_default_name.3
krb5_cc_set_flags.3
krb5_cc_store_cred.3
krb5_change_password.3
krb5_check_transited.3
krb5_check_transited_realms.3
krb5_checksum_disable.3
krb5_checksum_free.3
krb5_checksum_is_collision_proof.3
krb5_checksum_is_keyed.3
krb5_checksumsize.3
krb5_clear_error_string.3
krb5_closelog.3
krb5_config_file_free.3
krb5_config_free_strings.3
krb5_config_get.3
krb5_config_get_bool.3
krb5_config_get_bool_default.3
krb5_config_get_int.3
krb5_config_get_int_default.3
krb5_config_get_list.3
krb5_config_get_next.3
krb5_config_get_string.3
krb5_config_get_string_default.3
krb5_config_get_strings.3
krb5_config_get_time.3
krb5_config_get_time_default.3
krb5_config_parse_file.3
krb5_config_parse_file_multi.3
krb5_config_vget.3
krb5_config_vget_bool.3
krb5_config_vget_bool_default.3
krb5_config_vget_int.3
krb5_config_vget_int_default.3
krb5_config_vget_list.3
krb5_config_vget_next.3
krb5_config_vget_string.3
krb5_config_vget_string_default.3
krb5_config_vget_strings.3
krb5_config_vget_time.3
krb5_config_vget_time_default.3
krb5_context.3
krb5_copy_address.3
krb5_copy_addresses.3
krb5_copy_checksum.3
krb5_copy_data.3
krb5_copy_host_realm.3
krb5_copy_keyblock.3
krb5_copy_keyblock_contents.3
krb5_copy_principal.3
krb5_copy_ticket.3
krb5_create_checksum.3
krb5_creds.3
krb5_crypto_destroy.3
krb5_crypto_get_checksum_type.3
krb5_crypto_getblocksize.3
krb5_crypto_getconfoundersize.3
krb5_crypto_getenctype.3
krb5_crypto_getpadsize.3
krb5_crypto_init.3
krb5_data_alloc.3
krb5_data_copy.3
krb5_data_free.3
krb5_data_realloc.3
krb5_data_zero.3
krb5_decrypt.3
krb5_decrypt_EncryptedData.3
krb5_digest.3
krb5_digest_alloc.3
krb5_digest_free.3
krb5_digest_get_a1_hash.3
krb5_digest_get_client_binding.3
krb5_digest_get_identifier.3
krb5_digest_get_opaque.3
krb5_digest_get_responseData.3
krb5_digest_get_rsp.3
krb5_digest_get_server_nonce.3
krb5_digest_get_tickets.3
krb5_digest_init_request.3
krb5_digest_request.3
krb5_digest_set_authentication_user.3
krb5_digest_set_authid.3
krb5_digest_set_client_nonce.3
krb5_digest_set_digest.3
krb5_digest_set_hostname.3
krb5_digest_set_identifier.3
krb5_digest_set_method.3
krb5_digest_set_nonceCount.3
krb5_digest_set_opaque.3
krb5_digest_set_qop.3
krb5_digest_set_realm.3
krb5_digest_set_server_cb.3
krb5_digest_set_server_nonce.3
krb5_digest_set_type.3
krb5_digest_set_uri.3
krb5_digest_set_username.3
krb5_domain_x500_decode.3
krb5_domain_x500_encode.3
krb5_eai_to_heim_errno.3
krb5_encrypt.3
krb5_encrypt_EncryptedData.3
krb5_enctype_disable.3
krb5_enctype_to_string.3
krb5_enctype_valid.3
krb5_err.3
krb5_errx.3
krb5_expand_hostname.3
krb5_expand_hostname_realms.3
krb5_find_padata.3
krb5_format_time.3
krb5_free_address.3
krb5_free_addresses.3
krb5_free_authenticator.3
krb5_free_checksum.3
krb5_free_checksum_contents.3
krb5_free_config_files.3
krb5_free_context.3
krb5_free_data.3
krb5_free_data_contents.3
krb5_free_error_string.3
krb5_free_host_realm.3
krb5_free_kdc_rep.3
krb5_free_keyblock.3
krb5_free_keyblock_contents.3
krb5_free_krbhst.3
krb5_free_principal.3
krb5_free_salt.3
krb5_free_ticket.3
krb5_fwd_tgt_creds.3
krb5_generate_random_block.3
krb5_generate_random_keyblock.3
krb5_generate_subkey.3
krb5_get_all_client_addrs.3
krb5_get_all_server_addrs.3
krb5_get_cred_from_kdc.3
krb5_get_cred_from_kdc_opt.3
krb5_get_credentials.3
krb5_get_credentials_with_flags.3
krb5_get_default_config_files.3
krb5_get_default_principal.3
krb5_get_default_realm.3
krb5_get_default_realms.3
krb5_get_err_text.3
krb5_get_error_message.3
krb5_get_error_string.3
krb5_get_extra_addresses.3
krb5_get_fcache_version.3
krb5_get_forwarded_creds.3
krb5_get_host_realm.3
krb5_get_ignore_addresses.3
krb5_get_in_cred.3
krb5_get_in_tkt.3
krb5_get_in_tkt_with_keytab.3
krb5_get_in_tkt_with_password.3
krb5_get_in_tkt_with_skey.3
krb5_get_init_creds.3
krb5_get_init_creds_keytab.3
krb5_get_init_creds_opt_alloc.3
krb5_get_init_creds_opt_free.3
krb5_get_init_creds_opt_free_pkinit.3
krb5_get_init_creds_opt_init.3
krb5_get_init_creds_opt_set_address_list.3
krb5_get_init_creds_opt_set_anonymous.3
krb5_get_init_creds_opt_set_default_flags.3
krb5_get_init_creds_opt_set_etype_list.3
krb5_get_init_creds_opt_set_forwardable.3
krb5_get_init_creds_opt_set_pa_password.3
krb5_get_init_creds_opt_set_paq_request.3
krb5_get_init_creds_opt_set_pkinit.3
krb5_get_init_creds_opt_set_preauth_list.3
krb5_get_init_creds_opt_set_proxiable.3
krb5_get_init_creds_opt_set_renew_life.3
krb5_get_init_creds_opt_set_salt.3
krb5_get_init_creds_opt_set_tkt_life.3
krb5_get_init_creds_password.3
krb5_get_kdc_cred.3
krb5_get_krb524hst.3
krb5_get_krb_admin_hst.3
krb5_get_krb_changepw_hst.3
krb5_get_krbhst.3
krb5_get_pw_salt.3
krb5_get_server_rcache.3
krb5_get_use_admin_kdc.3
krb5_get_wrapped_length.3
krb5_getportbyname.3
krb5_h_addr2addr.3
krb5_h_addr2sockaddr.3
krb5_h_errno_to_heim_errno.3
krb5_have_error_string.3
krb5_hmac.3
krb5_init_context.3
krb5_init_ets.3
krb5_initlog.3
krb5_keyblock_get_enctype.3
krb5_keyblock_zero.3
krb5_keytab_entry.3
krb5_krbhst_format_string.3
krb5_krbhst_free.3
krb5_krbhst_get_addrinfo.3
krb5_krbhst_init.3
krb5_krbhst_init_flags.3
krb5_krbhst_next.3
krb5_krbhst_next_as_string.3
krb5_krbhst_reset.3
krb5_kt_add_entry.3
krb5_kt_close.3
krb5_kt_compare.3
krb5_kt_copy_entry_contents.3
krb5_kt_cursor.3
krb5_kt_default.3
krb5_kt_default_modify_name.3
krb5_kt_default_name.3
krb5_kt_end_seq_get.3
krb5_kt_free_entry.3
krb5_kt_get_entry.3
krb5_kt_get_name.3
krb5_kt_get_type.3
krb5_kt_next_entry.3
krb5_kt_ops.3
krb5_kt_read_service_key.3
krb5_kt_register.3
krb5_kt_remove_entry.3
krb5_kt_resolve.3.3
krb5_kt_start_seq_get
krb5_kuserok.3
krb5_log.3
krb5_log_msg.3
krb5_make_addrport.3
krb5_make_principal.3
krb5_max_sockaddr_size.3
krb5_openlog.3
krb5_padata_add.3
krb5_parse_address.3
krb5_parse_name.3
krb5_passwd_result_to_string.3
krb5_password_key_proc.3
krb5_prepend_config_files.3
krb5_prepend_config_files_default.3
krb5_princ_realm.3
krb5_princ_set_realm.3
krb5_principal.3
krb5_principal_compare.3
krb5_principal_compare_any_realm.3
krb5_principal_get_comp_string.3
krb5_principal_get_realm.3
krb5_principal_get_type.3
krb5_principal_match.3
krb5_principal_set_type.3
krb5_print_address.3
krb5_rc_close.3
krb5_rc_default.3
krb5_rc_default_name.3
krb5_rc_default_type.3
krb5_rc_destroy.3
krb5_rc_expunge.3
krb5_rc_get_lifespan.3
krb5_rc_get_name.3
krb5_rc_get_type.3
krb5_rc_initialize.3
krb5_rc_recover.3
krb5_rc_resolve.3
krb5_rc_resolve_full.3
krb5_rc_resolve_type.3
krb5_rc_store.3
krb5_rcache.3
krb5_realm_compare.3
krb5_ret_address.3
krb5_ret_addrs.3
krb5_ret_authdata.3
krb5_ret_creds.3
krb5_ret_data.3
krb5_ret_int16.3
krb5_ret_int32.3
krb5_ret_int8.3
krb5_ret_keyblock.3
krb5_ret_principal.3
krb5_ret_string.3
krb5_ret_stringz.3
krb5_ret_times.3
krb5_set_config_files.3
krb5_set_default_realm.3
krb5_set_error_string.3
krb5_set_extra_addresses.3
krb5_set_fcache_version.3
krb5_set_ignore_addresses.3
krb5_set_password.3
krb5_set_password_using_ccache.3
krb5_set_real_time.3
krb5_set_use_admin_kdc.3
krb5_set_warn_dest.3
krb5_sname_to_principal.3
krb5_sock_to_principal.3
krb5_sockaddr2address.3
krb5_sockaddr2port.3
krb5_sockaddr_uninteresting.3
krb5_storage.3
krb5_storage_clear_flags.3
krb5_storage_emem.3
krb5_storage_free.3
krb5_storage_from_data.3
krb5_storage_from_fd.3
krb5_storage_from_mem.3
krb5_storage_get_byteorder.3
krb5_storage_is_flags.3
krb5_storage_read.3
krb5_storage_seek.3
krb5_storage_set_byteorder.3
krb5_storage_set_eof_code.3
krb5_storage_set_flags.3
krb5_storage_to_data.3
krb5_storage_write.3
krb5_store_address.3
krb5_store_addrs.3
krb5_store_authdata.3
krb5_store_creds.3
krb5_store_data.3
krb5_store_int16.3
krb5_store_int32.3
krb5_store_int8.3
krb5_store_keyblock.3
krb5_store_principal.3
krb5_store_string.3
krb5_store_stringz.3
krb5_store_times.3
krb5_string_to_deltat.3
krb5_string_to_enctype.3
krb5_string_to_key.3
krb5_string_to_key_data.3
krb5_string_to_key_data_salt.3
krb5_string_to_key_data_salt_opaque.3
krb5_string_to_key_salt.3
krb5_string_to_key_salt_opaque.3
krb5_ticket.3
krb5_ticket_get_authorization_data_type.3
krb5_ticket_get_client.3
krb5_ticket_get_server.3
krb5_timeofday.3
krb5_unparse_name.3
krb5_unparse_name_fixed.3
krb5_unparse_name_fixed_short.3
krb5_unparse_name_short.3
krb5_us_timeofday.3
krb5_vabort.3
krb5_vabortx.3
krb5_verify_checksum.3
krb5_verify_init_creds.3
krb5_verify_init_creds_opt_init.3
krb5_verify_init_creds_opt_set_ap_req_nofail.3
krb5_verify_opt_init.3
krb5_verify_opt_set_ccache.3
krb5_verify_opt_set_flags.3
krb5_verify_opt_set_keytab.3
krb5_verify_opt_set_secure.3
krb5_verify_opt_set_service.3
krb5_verify_user.3
krb5_verify_user_lrealm.3
krb5_verify_user_opt.3
krb5_verr.3
krb5_verrx.3
krb5_vlog.3
krb5_vlog_msg.3
krb5_vset_error_string.3
krb5_vwarn.3
krb5_vwarnx.3
krb5_warn.3
krb5_warnx.3
.ta
.Fi
.Sh SEE ALSO
.Xr krb5.conf 5 ,
.Xr kerberos 8