crypto/heimdal/lib/krb5/krb5.3

   1 .\" Copyright (c) 2001, 2003 - 2006 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Id: krb5.3 18212 2006-10-03 10:39:35Z lha $
  33 .\"
  34 .Dd May  1, 2006
  35 .Dt KRB5 3
  36 .Os
  37 .Sh NAME
  38 .Nm krb5
  39 .Nd Kerberos 5 library
  40 .Sh LIBRARY
  41 Kerberos 5 Library (libkrb5, -lkrb5)
  42 .Sh SYNOPSIS
  43 .In krb5.h
  44 .Sh DESCRIPTION
  45 These functions constitute the Kerberos 5 library,
  46 .Em libkrb5 .
  47 .Sh LIST OF FUNCTIONS
  48 .sp 2
  49 .nf
  50 .ta \w'krb5_ticket_get_authorization_data_type.3'u+2n +\w'Description goes here'u
  51 \fIName/Page\fP \fIDescription\fP
  52 .ta \w'krb5_ticket_get_authorization_data_type.3'u+2n +\w'Description goes here'u+6nC
  53 .sp 5p
  54 krb524_convert_creds_kdc.3
  55 krb524_convert_creds_kdc_cache.3
  56 krb5_425_conv_principal.3
  57 krb5_425_conv_principal_ext.3
  58 krb5_524_conv_principal.3
  59 krb5_abort.3
  60 krb5_abortx.3
  61 krb5_acl_match_file.3
  62 krb5_acl_match_string.3
  63 krb5_add_et_list.3
  64 krb5_add_extra_addresses.3
  65 krb5_add_ignore_addresses.3
  66 krb5_addlog_dest.3
  67 krb5_addlog_func.3
  68 krb5_addr2sockaddr.3
  69 krb5_address.3
  70 krb5_address_compare.3
  71 krb5_address_order.3
  72 krb5_address_search.3
  73 krb5_addresses.3
  74 krb5_aname_to_localname.3
  75 krb5_anyaddr.3
  76 krb5_appdefault_boolean.3
  77 krb5_appdefault_string.3
  78 krb5_appdefault_time.3
  79 krb5_append_addresses.3
  80 krb5_auth_con_addflags.3
  81 krb5_auth_con_free.3
  82 krb5_auth_con_genaddrs.3
  83 krb5_auth_con_generatelocalsubkey.3
  84 krb5_auth_con_getaddrs.3
  85 krb5_auth_con_getauthenticator.3
  86 krb5_auth_con_getcksumtype.3
  87 krb5_auth_con_getflags.3
  88 krb5_auth_con_getkey.3
  89 krb5_auth_con_getkeytype.3
  90 krb5_auth_con_getlocalseqnumber.3
  91 krb5_auth_con_getlocalsubkey.3
  92 krb5_auth_con_getrcache.3
  93 krb5_auth_con_getremotesubkey.3
  94 krb5_auth_con_getuserkey.3
  95 krb5_auth_con_init.3
  96 krb5_auth_con_initivector.3
  97 krb5_auth_con_removeflags.3
  98 krb5_auth_con_setaddrs.3
  99 krb5_auth_con_setaddrs_from_fd.3
 100 krb5_auth_con_setcksumtype.3
 101 krb5_auth_con_setflags.3
 102 krb5_auth_con_setivector.3
 103 krb5_auth_con_setkey.3
 104 krb5_auth_con_setkeytype.3
 105 krb5_auth_con_setlocalseqnumber.3
 106 krb5_auth_con_setlocalsubkey.3
 107 krb5_auth_con_setrcache.3
 108 krb5_auth_con_setremoteseqnumber.3
 109 krb5_auth_con_setremotesubkey.3
 110 krb5_auth_con_setuserkey.3
 111 krb5_auth_context.3
 112 krb5_auth_getremoteseqnumber.3
 113 krb5_build_principal.3
 114 krb5_build_principal_ext.3
 115 krb5_build_principal_va.3
 116 krb5_build_principal_va_ext.3
 117 krb5_c_block_size.3
 118 krb5_c_checksum_length.3
 119 krb5_c_decrypt.3
 120 krb5_c_encrypt.3
 121 krb5_c_encrypt_length.3
 122 krb5_c_enctype_compare.3
 123 krb5_c_get_checksum.3
 124 krb5_c_is_coll_proof_cksum.3
 125 krb5_c_is_keyed_cksum.3
 126 krb5_c_make_checksum.3
 127 krb5_c_make_random_key.3
 128 krb5_c_set_checksum.3
 129 krb5_c_valid_cksumtype.3
 130 krb5_c_valid_enctype.3
 131 krb5_c_verify_checksum.3
 132 krb5_cc_cache_end_seq_get.3
 133 krb5_cc_cache_get_first.3
 134 krb5_cc_cache_match.3
 135 krb5_cc_cache_next.3
 136 krb5_cc_close.3
 137 krb5_cc_copy_cache.3
 138 krb5_cc_default.3
 139 krb5_cc_default_name.3
 140 krb5_cc_destroy.3
 141 krb5_cc_end_seq_get.3
 142 krb5_cc_gen_new.3
 143 krb5_cc_get_full_name.3
 144 krb5_cc_get_name.3
 145 krb5_cc_get_ops.3
 146 krb5_cc_get_principal.3
 147 krb5_cc_get_type.3
 148 krb5_cc_get_version.3
 149 krb5_cc_initialize.3
 150 krb5_cc_new_unique.3
 151 krb5_cc_next_cred.3
 152 krb5_cc_register.3
 153 krb5_cc_remove_cred.3
 154 krb5_cc_resolve.3
 155 krb5_cc_retrieve_cred.3
 156 krb5_cc_set_default_name.3
 157 krb5_cc_set_flags.3
 158 krb5_cc_store_cred.3
 159 krb5_change_password.3
 160 krb5_check_transited.3
 161 krb5_check_transited_realms.3
 162 krb5_checksum_disable.3
 163 krb5_checksum_free.3
 164 krb5_checksum_is_collision_proof.3
 165 krb5_checksum_is_keyed.3
 166 krb5_checksumsize.3
 167 krb5_clear_error_string.3
 168 krb5_closelog.3
 169 krb5_config_file_free.3
 170 krb5_config_free_strings.3
 171 krb5_config_get.3
 172 krb5_config_get_bool.3
 173 krb5_config_get_bool_default.3
 174 krb5_config_get_int.3
 175 krb5_config_get_int_default.3
 176 krb5_config_get_list.3
 177 krb5_config_get_next.3
 178 krb5_config_get_string.3
 179 krb5_config_get_string_default.3
 180 krb5_config_get_strings.3
 181 krb5_config_get_time.3
 182 krb5_config_get_time_default.3
 183 krb5_config_parse_file.3
 184 krb5_config_parse_file_multi.3
 185 krb5_config_vget.3
 186 krb5_config_vget_bool.3
 187 krb5_config_vget_bool_default.3
 188 krb5_config_vget_int.3
 189 krb5_config_vget_int_default.3
 190 krb5_config_vget_list.3
 191 krb5_config_vget_next.3
 192 krb5_config_vget_string.3
 193 krb5_config_vget_string_default.3
 194 krb5_config_vget_strings.3
 195 krb5_config_vget_time.3
 196 krb5_config_vget_time_default.3
 197 krb5_context.3
 198 krb5_copy_address.3
 199 krb5_copy_addresses.3
 200 krb5_copy_checksum.3
 201 krb5_copy_data.3
 202 krb5_copy_host_realm.3
 203 krb5_copy_keyblock.3
 204 krb5_copy_keyblock_contents.3
 205 krb5_copy_principal.3
 206 krb5_copy_ticket.3
 207 krb5_create_checksum.3
 208 krb5_creds.3
 209 krb5_crypto_destroy.3
 210 krb5_crypto_get_checksum_type.3
 211 krb5_crypto_getblocksize.3
 212 krb5_crypto_getconfoundersize.3
 213 krb5_crypto_getenctype.3
 214 krb5_crypto_getpadsize.3
 215 krb5_crypto_init.3
 216 krb5_data_alloc.3
 217 krb5_data_copy.3
 218 krb5_data_free.3
 219 krb5_data_realloc.3
 220 krb5_data_zero.3
 221 krb5_decrypt.3
 222 krb5_decrypt_EncryptedData.3
 223 krb5_digest.3
 224 krb5_digest_alloc.3
 225 krb5_digest_free.3
 226 krb5_digest_get_a1_hash.3
 227 krb5_digest_get_client_binding.3
 228 krb5_digest_get_identifier.3
 229 krb5_digest_get_opaque.3
 230 krb5_digest_get_responseData.3
 231 krb5_digest_get_rsp.3
 232 krb5_digest_get_server_nonce.3
 233 krb5_digest_get_tickets.3
 234 krb5_digest_init_request.3
 235 krb5_digest_request.3
 236 krb5_digest_set_authentication_user.3
 237 krb5_digest_set_authid.3
 238 krb5_digest_set_client_nonce.3
 239 krb5_digest_set_digest.3
 240 krb5_digest_set_hostname.3
 241 krb5_digest_set_identifier.3
 242 krb5_digest_set_method.3
 243 krb5_digest_set_nonceCount.3
 244 krb5_digest_set_opaque.3
 245 krb5_digest_set_qop.3
 246 krb5_digest_set_realm.3
 247 krb5_digest_set_server_cb.3
 248 krb5_digest_set_server_nonce.3
 249 krb5_digest_set_type.3
 250 krb5_digest_set_uri.3
 251 krb5_digest_set_username.3
 252 krb5_domain_x500_decode.3
 253 krb5_domain_x500_encode.3
 254 krb5_eai_to_heim_errno.3
 255 krb5_encrypt.3
 256 krb5_encrypt_EncryptedData.3
 257 krb5_enctype_disable.3
 258 krb5_enctype_to_string.3
 259 krb5_enctype_valid.3
 260 krb5_err.3
 261 krb5_errx.3
 262 krb5_expand_hostname.3
 263 krb5_expand_hostname_realms.3
 264 krb5_find_padata.3
 265 krb5_format_time.3
 266 krb5_free_address.3
 267 krb5_free_addresses.3
 268 krb5_free_authenticator.3
 269 krb5_free_checksum.3
 270 krb5_free_checksum_contents.3
 271 krb5_free_config_files.3
 272 krb5_free_context.3
 273 krb5_free_data.3
 274 krb5_free_data_contents.3
 275 krb5_free_error_string.3
 276 krb5_free_host_realm.3
 277 krb5_free_kdc_rep.3
 278 krb5_free_keyblock.3
 279 krb5_free_keyblock_contents.3
 280 krb5_free_krbhst.3
 281 krb5_free_principal.3
 282 krb5_free_salt.3
 283 krb5_free_ticket.3
 284 krb5_fwd_tgt_creds.3
 285 krb5_generate_random_block.3
 286 krb5_generate_random_keyblock.3
 287 krb5_generate_subkey.3
 288 krb5_get_all_client_addrs.3
 289 krb5_get_all_server_addrs.3
 290 krb5_get_cred_from_kdc.3
 291 krb5_get_cred_from_kdc_opt.3
 292 krb5_get_credentials.3
 293 krb5_get_credentials_with_flags.3
 294 krb5_get_default_config_files.3
 295 krb5_get_default_principal.3
 296 krb5_get_default_realm.3
 297 krb5_get_default_realms.3
 298 krb5_get_err_text.3
 299 krb5_get_error_message.3
 300 krb5_get_error_string.3
 301 krb5_get_extra_addresses.3
 302 krb5_get_fcache_version.3
 303 krb5_get_forwarded_creds.3
 304 krb5_get_host_realm.3
 305 krb5_get_ignore_addresses.3
 306 krb5_get_in_cred.3
 307 krb5_get_in_tkt.3
 308 krb5_get_in_tkt_with_keytab.3
 309 krb5_get_in_tkt_with_password.3
 310 krb5_get_in_tkt_with_skey.3
 311 krb5_get_init_creds.3
 312 krb5_get_init_creds_keytab.3
 313 krb5_get_init_creds_opt_alloc.3
 314 krb5_get_init_creds_opt_free.3
 315 krb5_get_init_creds_opt_free_pkinit.3
 316 krb5_get_init_creds_opt_init.3
 317 krb5_get_init_creds_opt_set_address_list.3
 318 krb5_get_init_creds_opt_set_anonymous.3
 319 krb5_get_init_creds_opt_set_default_flags.3
 320 krb5_get_init_creds_opt_set_etype_list.3
 321 krb5_get_init_creds_opt_set_forwardable.3
 322 krb5_get_init_creds_opt_set_pa_password.3
 323 krb5_get_init_creds_opt_set_paq_request.3
 324 krb5_get_init_creds_opt_set_pkinit.3
 325 krb5_get_init_creds_opt_set_preauth_list.3
 326 krb5_get_init_creds_opt_set_proxiable.3
 327 krb5_get_init_creds_opt_set_renew_life.3
 328 krb5_get_init_creds_opt_set_salt.3
 329 krb5_get_init_creds_opt_set_tkt_life.3
 330 krb5_get_init_creds_password.3
 331 krb5_get_kdc_cred.3
 332 krb5_get_krb524hst.3
 333 krb5_get_krb_admin_hst.3
 334 krb5_get_krb_changepw_hst.3
 335 krb5_get_krbhst.3
 336 krb5_get_pw_salt.3
 337 krb5_get_server_rcache.3
 338 krb5_get_use_admin_kdc.3
 339 krb5_get_wrapped_length.3
 340 krb5_getportbyname.3
 341 krb5_h_addr2addr.3
 342 krb5_h_addr2sockaddr.3
 343 krb5_h_errno_to_heim_errno.3
 344 krb5_have_error_string.3
 345 krb5_hmac.3
 346 krb5_init_context.3
 347 krb5_init_ets.3
 348 krb5_initlog.3
 349 krb5_keyblock_get_enctype.3
 350 krb5_keyblock_zero.3
 351 krb5_keytab_entry.3
 352 krb5_krbhst_format_string.3
 353 krb5_krbhst_free.3
 354 krb5_krbhst_get_addrinfo.3
 355 krb5_krbhst_init.3
 356 krb5_krbhst_init_flags.3
 357 krb5_krbhst_next.3
 358 krb5_krbhst_next_as_string.3
 359 krb5_krbhst_reset.3
 360 krb5_kt_add_entry.3
 361 krb5_kt_close.3
 362 krb5_kt_compare.3
 363 krb5_kt_copy_entry_contents.3
 364 krb5_kt_cursor.3
 365 krb5_kt_default.3
 366 krb5_kt_default_modify_name.3
 367 krb5_kt_default_name.3
 368 krb5_kt_end_seq_get.3
 369 krb5_kt_free_entry.3
 370 krb5_kt_get_entry.3
 371 krb5_kt_get_name.3
 372 krb5_kt_get_type.3
 373 krb5_kt_next_entry.3
 374 krb5_kt_ops.3
 375 krb5_kt_read_service_key.3
 376 krb5_kt_register.3
 377 krb5_kt_remove_entry.3
 378 krb5_kt_resolve.3.3
 379 krb5_kt_start_seq_get
 380 krb5_kuserok.3
 381 krb5_log.3
 382 krb5_log_msg.3
 383 krb5_make_addrport.3
 384 krb5_make_principal.3
 385 krb5_max_sockaddr_size.3
 386 krb5_openlog.3
 387 krb5_padata_add.3
 388 krb5_parse_address.3
 389 krb5_parse_name.3
 390 krb5_passwd_result_to_string.3
 391 krb5_password_key_proc.3
 392 krb5_prepend_config_files.3
 393 krb5_prepend_config_files_default.3
 394 krb5_princ_realm.3
 395 krb5_princ_set_realm.3
 396 krb5_principal.3
 397 krb5_principal_compare.3
 398 krb5_principal_compare_any_realm.3
 399 krb5_principal_get_comp_string.3
 400 krb5_principal_get_realm.3
 401 krb5_principal_get_type.3
 402 krb5_principal_match.3
 403 krb5_principal_set_type.3
 404 krb5_print_address.3
 405 krb5_rc_close.3
 406 krb5_rc_default.3
 407 krb5_rc_default_name.3
 408 krb5_rc_default_type.3
 409 krb5_rc_destroy.3
 410 krb5_rc_expunge.3
 411 krb5_rc_get_lifespan.3
 412 krb5_rc_get_name.3
 413 krb5_rc_get_type.3
 414 krb5_rc_initialize.3
 415 krb5_rc_recover.3
 416 krb5_rc_resolve.3
 417 krb5_rc_resolve_full.3
 418 krb5_rc_resolve_type.3
 419 krb5_rc_store.3
 420 krb5_rcache.3
 421 krb5_realm_compare.3
 422 krb5_ret_address.3
 423 krb5_ret_addrs.3
 424 krb5_ret_authdata.3
 425 krb5_ret_creds.3
 426 krb5_ret_data.3
 427 krb5_ret_int16.3
 428 krb5_ret_int32.3
 429 krb5_ret_int8.3
 430 krb5_ret_keyblock.3
 431 krb5_ret_principal.3
 432 krb5_ret_string.3
 433 krb5_ret_stringz.3
 434 krb5_ret_times.3
 435 krb5_set_config_files.3
 436 krb5_set_default_realm.3
 437 krb5_set_error_string.3
 438 krb5_set_extra_addresses.3
 439 krb5_set_fcache_version.3
 440 krb5_set_ignore_addresses.3
 441 krb5_set_password.3
 442 krb5_set_password_using_ccache.3
 443 krb5_set_real_time.3
 444 krb5_set_use_admin_kdc.3
 445 krb5_set_warn_dest.3
 446 krb5_sname_to_principal.3
 447 krb5_sock_to_principal.3
 448 krb5_sockaddr2address.3
 449 krb5_sockaddr2port.3
 450 krb5_sockaddr_uninteresting.3
 451 krb5_storage.3
 452 krb5_storage_clear_flags.3
 453 krb5_storage_emem.3
 454 krb5_storage_free.3
 455 krb5_storage_from_data.3
 456 krb5_storage_from_fd.3
 457 krb5_storage_from_mem.3
 458 krb5_storage_get_byteorder.3
 459 krb5_storage_is_flags.3
 460 krb5_storage_read.3
 461 krb5_storage_seek.3
 462 krb5_storage_set_byteorder.3
 463 krb5_storage_set_eof_code.3
 464 krb5_storage_set_flags.3
 465 krb5_storage_to_data.3
 466 krb5_storage_write.3
 467 krb5_store_address.3
 468 krb5_store_addrs.3
 469 krb5_store_authdata.3
 470 krb5_store_creds.3
 471 krb5_store_data.3
 472 krb5_store_int16.3
 473 krb5_store_int32.3
 474 krb5_store_int8.3
 475 krb5_store_keyblock.3
 476 krb5_store_principal.3
 477 krb5_store_string.3
 478 krb5_store_stringz.3
 479 krb5_store_times.3
 480 krb5_string_to_deltat.3
 481 krb5_string_to_enctype.3
 482 krb5_string_to_key.3
 483 krb5_string_to_key_data.3
 484 krb5_string_to_key_data_salt.3
 485 krb5_string_to_key_data_salt_opaque.3
 486 krb5_string_to_key_salt.3
 487 krb5_string_to_key_salt_opaque.3
 488 krb5_ticket.3
 489 krb5_ticket_get_authorization_data_type.3
 490 krb5_ticket_get_client.3
 491 krb5_ticket_get_server.3
 492 krb5_timeofday.3
 493 krb5_unparse_name.3
 494 krb5_unparse_name_fixed.3
 495 krb5_unparse_name_fixed_short.3
 496 krb5_unparse_name_short.3
 497 krb5_us_timeofday.3
 498 krb5_vabort.3
 499 krb5_vabortx.3
 500 krb5_verify_checksum.3
 501 krb5_verify_init_creds.3
 502 krb5_verify_init_creds_opt_init.3
 503 krb5_verify_init_creds_opt_set_ap_req_nofail.3
 504 krb5_verify_opt_init.3
 505 krb5_verify_opt_set_ccache.3
 506 krb5_verify_opt_set_flags.3
 507 krb5_verify_opt_set_keytab.3
 508 krb5_verify_opt_set_secure.3
 509 krb5_verify_opt_set_service.3
 510 krb5_verify_user.3
 511 krb5_verify_user_lrealm.3
 512 krb5_verify_user_opt.3
 513 krb5_verr.3
 514 krb5_verrx.3
 515 krb5_vlog.3
 516 krb5_vlog_msg.3
 517 krb5_vset_error_string.3
 518 krb5_vwarn.3
 519 krb5_vwarnx.3
 520 krb5_warn.3
 521 krb5_warnx.3
 522 .ta
 523 .Fi
 524 .Sh SEE ALSO
 525 .Xr krb5.conf 5 ,
 526 .Xr kerberos 8