2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIBKRB5 3LIB "April 9, 2016"
8 libkrb5 \- MIT Kerberos 5 library
12 \fBcc\fR \fB-I/usr/include/kerberosv5\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lkrb5\fR [ \fIlibrary\fR...]
13 #include <\fBkrb5.h\fR>
14 #include <\fBcom_err.h\fR>
19 The functions in this library are the routines that comprise the MIT Kerberos 5
23 The shared object \fBlibkrb5.so\fR provides the public interface defined below.
26 The \fBkrb5\fR library is provided as a convenience to allow native \fBkrb5\fR
27 applications to be built and to run. Compatibility between Solaris releases of
28 the \fBkrb5\fR interface is not guaranteed. For new applications that require
29 these features, \fBlibgss\fR(3LIB) is recommended.
32 For detailed documentation on the \fBkrb5\fR interface, see the MIT Kerberos 5
33 web site at \fBhttp://web.mit.edu/kerberos\fR.
36 The \fBkrb5_cc_gen_new\fR routine, listed in \fBkrb5.h\fR section, is flawed
37 and should be avoided. Until a new routine is available from MIT, the following
45 snprintf(ccname,sizeof(ccname),"FILE:/tmp/krb5cc_%d_XXXXXX",
48 if ((tmpfd = mkstemp(ccname+strlen("FILE:")))==-1) {
49 log("mkstemp(): %.100s", strerror(errno));
53 if (fchmod(tmpfd,S_IRUSR | S_IWUSR) == -1) {
54 log("fchmod(): %.100s", strerror(errno));
60 problem = krb5_cc_resolve(authctxt->krb5_ctx, ccname, &ccache);
68 The \fBkrb5_string_to_key\fR and \fBkrb5_string_to_key\fR routines, listed in
69 \fBkrb5.h\fR section, are part of the old cryptosystem and should not be used
85 \fBkrb5_address_compare\fR
89 \fBkrb5_address_order\fR
93 \fBkrb5_address_search\fR
97 \fBkrb5_aname_to_localname\fR
101 \fBkrb5_appdefault_boolean\fR
105 \fBkrb5_appdefault_string\fR
109 \fBkrb5_auth_con_free\fR
113 \fBkrb5_auth_con_genaddrs\fR
117 \fBkrb5_auth_con_get_checksum_func\fR
121 \fBkrb5_auth_con_getaddrs\fR
125 \fBkrb5_auth_con_getauthenticator\fR
129 \fBkrb5_auth_con_getflags\fR
133 \fBkrb5_auth_con_getkey\fR
137 \fBkrb5_auth_con_getlocalseqnumber\fR
141 \fBkrb5_auth_con_getrcache\fR
145 \fBkrb5_auth_con_getrecvsubkey\fR
149 \fBkrb5_auth_con_getremoteseqnumber\fR
153 \fBkrb5_auth_con_getsendsubkey\fR
157 \fBkrb5_auth_con_init\fR
161 \fBkrb5_auth_con_set_checksum_func\fR
165 \fBkrb5_auth_con_setaddrs\fR
169 \fBkrb5_auth_con_setflags\fR
173 \fBkrb5_auth_con_setports\fR
177 \fBkrb5_auth_con_setrcache\fR
181 \fBkrb5_auth_con_setrecvsubkey\fR
185 \fBkrb5_auth_con_setsendsubkey\fR
189 \fBkrb5_auth_con_setuseruserkey\fR
193 \fBkrb5_build_principal\fR
197 \fBkrb5_build_principal_ext\fR
201 \fBkrb5_c_block_size\fR
205 \fBkrb5_c_checksum_length\fR
217 \fBkrb5_c_encrypt_length\fR
221 \fBkrb5_c_enctype_compare\fR
225 \fBkrb5_c_free_state\fR
229 \fBkrb5_c_init_state\fR
233 \fBkrb5_c_is_coll_proof_cksum\fR
237 \fBkrb5_c_is_keyed_cksum\fR
241 \fBkrb5_c_keyed_checksum_types\fR
245 \fBkrb5_c_make_checksum\fR
249 \fBkrb5_c_make_random_key\fR
253 \fBkrb5_c_random_make_octets\fR
257 \fBkrb5_c_string_to_key\fR
261 \fBkrb5_c_string_to_key_with_params\fR
265 \fBkrb5_c_valid_cksumtype\fR
269 \fBkrb5_c_valid_enctype\fR
273 \fBkrb5_c_verify_checksum\fR
281 \fBkrb5_cc_copy_creds\fR
285 \fBkrb5_cc_default\fR
289 \fBkrb5_cc_default_name\fR
293 \fBkrb5_cc_destroy\fR
297 \fBkrb5_cc_end_seq_get\fR
301 \fBkrb5_cc_gen_new\fR
305 \fBkrb5_cc_get_name\fR
309 \fBkrb5_cc_get_principal\fR
313 \fBkrb5_cc_get_type\fR
317 \fBkrb5_cc_initialize\fR
321 \fBkrb5_cc_next_cred\fR
325 \fBkrb5_cc_remove_cred\fR
329 \fBkrb5_cc_resolve\fR
333 \fBkrb5_cc_retrieve_cred\fR
337 \fBkrb5_cc_set_default_name\fR
341 \fBkrb5_cc_set_flags\fR
345 \fBkrb5_cc_start_seq_get\fR
349 \fBkrb5_cc_store_cred\fR
353 \fBkrb5_change_password\fR
357 \fBkrb5_cksumtype_to_string\fR
361 \fBkrb5_copy_addresses\fR
365 \fBkrb5_copy_authdata\fR
369 \fBkrb5_copy_authenticator\fR
373 \fBkrb5_copy_checksum\fR
377 \fBkrb5_copy_creds\fR
385 \fBkrb5_copy_keyblock\fR
389 \fBkrb5_copy_keyblock_contents\fR
393 \fBkrb5_copy_principal\fR
397 \fBkrb5_copy_ticket\fR
401 \fBkrb5_decode_authdata_container\fR
405 \fBkrb5_decode_ticket\fR
409 \fBkrb5_deltat_to_string\fR
413 \fBkrb5_encode_authdata_container\fR
417 \fBkrb5_enctype_to_string\fR
421 \fBkrb5_free_addresses\fR
425 \fBkrb5_free_ap_rep_enc_part\fR
429 \fBkrb5_free_authdata\fR
433 \fBkrb5_free_authenticator\fR
437 \fBkrb5_free_checksum\fR
441 \fBkrb5_free_checksum_contents\fR
445 \fBkrb5_free_cksumtypes\fR
449 \fBkrb5_free_context\fR
453 \fBkrb5_free_cred_contents\fR
457 \fBkrb5_free_creds\fR
465 \fBkrb5_free_data_contents\fR
469 \fBkrb5_free_default_realm\fR
473 \fBkrb5_free_error\fR
477 \fBkrb5_free_host_realm\fR
481 \fBkrb5_free_keyblock\fR
485 \fBkrb5_free_keyblock_contents\fR
489 \fBkrb5_free_keytab_entry_contents\fR
493 \fBkrb5_free_principal\fR
497 \fBkrb5_free_realm_string\fR
501 \fBkrb5_free_tgt_creds\fR
505 \fBkrb5_free_ticket\fR
509 \fBkrb5_free_unparsed_name\fR
513 \fBkrb5_fwd_tgt_creds\fR
517 \fBkrb5_get_credentials\fR
521 \fBkrb5_get_credentials_renew\fR
525 \fBkrb5_get_credentials_validate\fR
529 \fBkrb5_get_default_realm\fR
533 \fBkrb5_get_host_realm\fR
537 \fBkrb5_get_init_creds_keytab\fR
541 \fBkrb5_get_init_creds_opt_init\fR
545 \fBkrb5_get_init_creds_opt_set_address_list\fR
549 \fBkrb5_get_init_creds_opt_set_etype_list\fR
553 \fBkrb5_get_init_creds_opt_set_forwardable\fR
557 \fBkrb5_get_init_creds_opt_set_preauth_list\fR
561 \fBkrb5_get_init_creds_opt_set_proxiable\fR
565 \fBkrb5_get_init_creds_opt_set_renew_life\fR
569 \fBkrb5_get_init_creds_opt_set_salt\fR
573 \fBkrb5_get_init_creds_opt_set_tkt_life\fR
577 \fBkrb5_get_key_data\fR
581 \fBkrb5_get_key_enctype\fR
585 \fBkrb5_get_key_length\fR
589 \fBkrb5_get_init_creds_password\fR
593 \fBkrb5_get_permitted_enctypes\fR
597 \fBkrb5_get_profile\fR
601 \fBkrb5_get_prompt_types\fR
605 \fBkrb5_get_renewed_creds\fR
609 \fBkrb5_get_server_rcache\fR
613 \fBkrb5_get_validated_creds\fR
617 \fBkrb5_init_allocated_keyblock\fR
621 \fBkrb5_init_context\fR
625 \fBkrb5_init_keyblock\fR
629 \fBkrb5_init_secure_context\fR
633 \fBkrb5_is_thread_safe\fR
637 \fBkrb5_kt_add_entry\fR
645 \fBkrb5_kt_default\fR
649 \fBkrb5_kt_default_name\fR
653 \fBkrb5_kt_end_seq_get\fR
657 \fBkrb5_kt_get_entry\fR
661 \fBkrb5_kt_get_name\fR
665 \fBkrb5_kt_get_type\fR
669 \fBkrb5_kt_next_entry\fR
673 \fBkrb5_kt_read_service_key\fR
677 \fBkrb5_kt_remove_entry\fR
681 \fBkrb5_kt_resolve\fR
685 \fBkrb5_kt_start_seq_get\fR
713 \fBkrb5_mk_req_extended\fR
725 \fBkrb5_os_localaddr\fR
729 \fBkrb5_pac_add_buffer\fR
737 \fBkrb5_pac_get_types\fR
741 \fBkrb5_pac_get_buffer\fR
753 \fBkrb5_pac_verify\fR
757 \fBkrb5_parse_name\fR
761 \fBkrb5_principal_compare\fR
765 \fBkrb5_principal2salt\fR
769 \fBkrb5_prompter_posix\fR
797 \fBkrb5_read_password\fR
801 \fBkrb5_realm_compare\fR
805 \fBkrb5_realm_iterator\fR
809 \fBkrb5_realm_iterator_create\fR
813 \fBkrb5_realm_iterator_free\fR
821 \fBkrb5_recvauth_version\fR
825 \fBkrb5_salttype_to_string\fR
833 \fBkrb5_set_default_realm\fR
837 \fBkrb5_set_default_tgs_enctypes\fR
841 \fBkrb5_set_key_data\fR
845 \fBkrb5_set_key_enctype\fR
849 \fBkrb5_set_key_length\fR
853 \fBkrb5_set_password\fR
857 \fBkrb5_set_password_using_ccache\fR
861 \fBkrb5_set_principal_realm\fR
865 \fBkrb5_set_real_time\fR
869 \fBkrb5_sname_to_principal\fR
873 \fBkrb5_string_to_cksumtype\fR
877 \fBkrb5_string_to_deltat\fR
881 \fBkrb5_string_to_enctype\fR
885 \fBkrb5_string_to_key\fR
889 \fBkrb5_string_to_salttype\fR
893 \fBkrb5_string_to_timestamp\fR
901 \fBkrb5_timestamp_to_sfstring\fR
905 \fBkrb5_timestamp_to_string\fR
909 \fBkrb5_unparse_name\fR
913 \fBkrb5_unparse_name_ext\fR
917 \fBkrb5_us_timeofday\fR
921 \fBkrb5_use_enctype\fR
925 \fBkrb5_verify_init_creds\fR
929 \fBkrb5_verify_init_creds_opt_init\fR
933 \fBkrb5_verify_init_creds_opt_set_ap_req_nofail\fR
941 \fBkrb5_xfree_wrap\fR
946 \fB\fB/usr/lib/libkrb5.so.1\fR\fR
955 \fB\fB/usr/lib/64/libkrb5.so.1\fR\fR
963 See \fBattributes\fR(5) for descriptions of the following attributes:
971 ATTRIBUTE TYPE ATTRIBUTE VALUE
973 Interface Stability Volatile
980 \fBkrb5-config\fR(1), \fBlibgss\fR(3LIB), \fBattributes\fR(5)