8354 sync regcomp(3C) with upstream (fix make catalog)
[unleashed/tickless.git] / usr / src / man / man3lib / libkrb5.3lib
blobe5a68aa1f23beec5a7e6baa926205f0189202be1
1 '\" te
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"
7 .SH NAME
8 libkrb5 \- MIT Kerberos 5 library
9 .SH SYNOPSIS
10 .LP
11 .nf
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>
15 .fi
17 .SH DESCRIPTION
18 .LP
19 The functions in this library are the routines that comprise the MIT Kerberos 5
20 library.
21 .SH INTERFACES
22 .LP
23 The shared object \fBlibkrb5.so\fR provides the public interface defined below.
24 .sp
25 .LP
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.
30 .sp
31 .LP
32 For detailed documentation on the \fBkrb5\fR interface, see the MIT Kerberos 5
33 web site at \fBhttp://web.mit.edu/kerberos\fR.
34 .sp
35 .LP
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
38 can be done:
39 .sp
40 .in +2
41 .nf
42 char ccname[40];
43 int tmpfd;
45 snprintf(ccname,sizeof(ccname),"FILE:/tmp/krb5cc_%d_XXXXXX",
46         geteuid());
48 if ((tmpfd = mkstemp(ccname+strlen("FILE:")))==-1) {
49         log("mkstemp(): %.100s", strerror(errno));
50         problem = errno;
51         goto fail;
53 if (fchmod(tmpfd,S_IRUSR | S_IWUSR) == -1) {
54         log("fchmod(): %.100s", strerror(errno));
55         close(tmpfd);
56         problem = errno;
57         goto fail;
59  close(tmpfd);
60 problem = krb5_cc_resolve(authctxt->krb5_ctx, ccname, &ccache);
61 \&...
62 fail:
63 .fi
64 .in -2
66 .sp
67 .LP
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
70 in new apps.
71 .SS "com_err.h"
72 .in +2
73 \fBcom_err\fR
74 .in -2
75 .br
76 .in +2
77 \fBcom_err_va\fR
78 .in -2
79 .br
80 .in +2
81 \fBerror_message\fR
82 .in -2
83 .SS "krb5.h"
84 .in +2
85 \fBkrb5_address_compare\fR
86 .in -2
87 .br
88 .in +2
89 \fBkrb5_address_order\fR
90 .in -2
91 .br
92 .in +2
93 \fBkrb5_address_search\fR
94 .in -2
95 .br
96 .in +2
97 \fBkrb5_aname_to_localname\fR
98 .in -2
99 .br
100 .in +2
101 \fBkrb5_appdefault_boolean\fR
102 .in -2
104 .in +2
105 \fBkrb5_appdefault_string\fR
106 .in -2
108 .in +2
109 \fBkrb5_auth_con_free\fR
110 .in -2
112 .in +2
113 \fBkrb5_auth_con_genaddrs\fR
114 .in -2
116 .in +2
117 \fBkrb5_auth_con_get_checksum_func\fR
118 .in -2
120 .in +2
121 \fBkrb5_auth_con_getaddrs\fR
122 .in -2
124 .in +2
125 \fBkrb5_auth_con_getauthenticator\fR
126 .in -2
128 .in +2
129 \fBkrb5_auth_con_getflags\fR
130 .in -2
132 .in +2
133 \fBkrb5_auth_con_getkey\fR
134 .in -2
136 .in +2
137 \fBkrb5_auth_con_getlocalseqnumber\fR
138 .in -2
140 .in +2
141 \fBkrb5_auth_con_getrcache\fR
142 .in -2
144 .in +2
145 \fBkrb5_auth_con_getrecvsubkey\fR
146 .in -2
148 .in +2
149 \fBkrb5_auth_con_getremoteseqnumber\fR
150 .in -2
152 .in +2
153 \fBkrb5_auth_con_getsendsubkey\fR
154 .in -2
156 .in +2
157 \fBkrb5_auth_con_init\fR
158 .in -2
160 .in +2
161 \fBkrb5_auth_con_set_checksum_func\fR
162 .in -2
164 .in +2
165 \fBkrb5_auth_con_setaddrs\fR
166 .in -2
168 .in +2
169 \fBkrb5_auth_con_setflags\fR
170 .in -2
172 .in +2
173 \fBkrb5_auth_con_setports\fR
174 .in -2
176 .in +2
177 \fBkrb5_auth_con_setrcache\fR
178 .in -2
180 .in +2
181 \fBkrb5_auth_con_setrecvsubkey\fR
182 .in -2
184 .in +2
185 \fBkrb5_auth_con_setsendsubkey\fR
186 .in -2
188 .in +2
189 \fBkrb5_auth_con_setuseruserkey\fR
190 .in -2
192 .in +2
193 \fBkrb5_build_principal\fR
194 .in -2
196 .in +2
197 \fBkrb5_build_principal_ext\fR
198 .in -2
200 .in +2
201 \fBkrb5_c_block_size\fR
202 .in -2
204 .in +2
205 \fBkrb5_c_checksum_length\fR
206 .in -2
208 .in +2
209 \fBkrb5_c_decrypt\fR
210 .in -2
212 .in +2
213 \fBkrb5_c_encrypt\fR
214 .in -2
216 .in +2
217 \fBkrb5_c_encrypt_length\fR
218 .in -2
220 .in +2
221 \fBkrb5_c_enctype_compare\fR
222 .in -2
224 .in +2
225 \fBkrb5_c_free_state\fR
226 .in -2
228 .in +2
229 \fBkrb5_c_init_state\fR
230 .in -2
232 .in +2
233 \fBkrb5_c_is_coll_proof_cksum\fR
234 .in -2
236 .in +2
237 \fBkrb5_c_is_keyed_cksum\fR
238 .in -2
240 .in +2
241 \fBkrb5_c_keyed_checksum_types\fR
242 .in -2
244 .in +2
245 \fBkrb5_c_make_checksum\fR
246 .in -2
248 .in +2
249 \fBkrb5_c_make_random_key\fR
250 .in -2
252 .in +2
253 \fBkrb5_c_random_make_octets\fR
254 .in -2
256 .in +2
257 \fBkrb5_c_string_to_key\fR
258 .in -2
260 .in +2
261 \fBkrb5_c_string_to_key_with_params\fR
262 .in -2
264 .in +2
265 \fBkrb5_c_valid_cksumtype\fR
266 .in -2
268 .in +2
269 \fBkrb5_c_valid_enctype\fR
270 .in -2
272 .in +2
273 \fBkrb5_c_verify_checksum\fR
274 .in -2
276 .in +2
277 \fBkrb5_cc_close\fR
278 .in -2
280 .in +2
281 \fBkrb5_cc_copy_creds\fR
282 .in -2
284 .in +2
285 \fBkrb5_cc_default\fR
286 .in -2
288 .in +2
289 \fBkrb5_cc_default_name\fR
290 .in -2
292 .in +2
293 \fBkrb5_cc_destroy\fR
294 .in -2
296 .in +2
297 \fBkrb5_cc_end_seq_get\fR
298 .in -2
300 .in +2
301 \fBkrb5_cc_gen_new\fR
302 .in -2
304 .in +2
305 \fBkrb5_cc_get_name\fR
306 .in -2
308 .in +2
309 \fBkrb5_cc_get_principal\fR
310 .in -2
312 .in +2
313 \fBkrb5_cc_get_type\fR
314 .in -2
316 .in +2
317 \fBkrb5_cc_initialize\fR
318 .in -2
320 .in +2
321 \fBkrb5_cc_next_cred\fR
322 .in -2
324 .in +2
325 \fBkrb5_cc_remove_cred\fR
326 .in -2
328 .in +2
329 \fBkrb5_cc_resolve\fR
330 .in -2
332 .in +2
333 \fBkrb5_cc_retrieve_cred\fR
334 .in -2
336 .in +2
337 \fBkrb5_cc_set_default_name\fR
338 .in -2
340 .in +2
341 \fBkrb5_cc_set_flags\fR
342 .in -2
344 .in +2
345 \fBkrb5_cc_start_seq_get\fR
346 .in -2
348 .in +2
349 \fBkrb5_cc_store_cred\fR
350 .in -2
352 .in +2
353 \fBkrb5_change_password\fR
354 .in -2
356 .in +2
357 \fBkrb5_cksumtype_to_string\fR
358 .in -2
360 .in +2
361 \fBkrb5_copy_addresses\fR
362 .in -2
364 .in +2
365 \fBkrb5_copy_authdata\fR
366 .in -2
368 .in +2
369 \fBkrb5_copy_authenticator\fR
370 .in -2
372 .in +2
373 \fBkrb5_copy_checksum\fR
374 .in -2
376 .in +2
377 \fBkrb5_copy_creds\fR
378 .in -2
380 .in +2
381 \fBkrb5_copy_data\fR
382 .in -2
384 .in +2
385 \fBkrb5_copy_keyblock\fR
386 .in -2
388 .in +2
389 \fBkrb5_copy_keyblock_contents\fR
390 .in -2
392 .in +2
393 \fBkrb5_copy_principal\fR
394 .in -2
396 .in +2
397 \fBkrb5_copy_ticket\fR
398 .in -2
400 .in +2
401 \fBkrb5_decode_authdata_container\fR
402 .in -2
404 .in +2
405 \fBkrb5_decode_ticket\fR
406 .in -2
408 .in +2
409 \fBkrb5_deltat_to_string\fR
410 .in -2
412 .in +2
413 \fBkrb5_encode_authdata_container\fR
414 .in -2
416 .in +2
417 \fBkrb5_enctype_to_string\fR
418 .in -2
420 .in +2
421 \fBkrb5_free_addresses\fR
422 .in -2
424 .in +2
425 \fBkrb5_free_ap_rep_enc_part\fR
426 .in -2
428 .in +2
429 \fBkrb5_free_authdata\fR
430 .in -2
432 .in +2
433 \fBkrb5_free_authenticator\fR
434 .in -2
436 .in +2
437 \fBkrb5_free_checksum\fR
438 .in -2
440 .in +2
441 \fBkrb5_free_checksum_contents\fR
442 .in -2
444 .in +2
445 \fBkrb5_free_cksumtypes\fR
446 .in -2
448 .in +2
449 \fBkrb5_free_context\fR
450 .in -2
452 .in +2
453 \fBkrb5_free_cred_contents\fR
454 .in -2
456 .in +2
457 \fBkrb5_free_creds\fR
458 .in -2
460 .in +2
461 \fBkrb5_free_data\fR
462 .in -2
464 .in +2
465 \fBkrb5_free_data_contents\fR
466 .in -2
468 .in +2
469 \fBkrb5_free_default_realm\fR
470 .in -2
472 .in +2
473 \fBkrb5_free_error\fR
474 .in -2
476 .in +2
477 \fBkrb5_free_host_realm\fR
478 .in -2
480 .in +2
481 \fBkrb5_free_keyblock\fR
482 .in -2
484 .in +2
485 \fBkrb5_free_keyblock_contents\fR
486 .in -2
488 .in +2
489 \fBkrb5_free_keytab_entry_contents\fR
490 .in -2
492 .in +2
493 \fBkrb5_free_principal\fR
494 .in -2
496 .in +2
497 \fBkrb5_free_realm_string\fR
498 .in -2
500 .in +2
501 \fBkrb5_free_tgt_creds\fR
502 .in -2
504 .in +2
505 \fBkrb5_free_ticket\fR
506 .in -2
508 .in +2
509 \fBkrb5_free_unparsed_name\fR
510 .in -2
512 .in +2
513 \fBkrb5_fwd_tgt_creds\fR
514 .in -2
516 .in +2
517 \fBkrb5_get_credentials\fR
518 .in -2
520 .in +2
521 \fBkrb5_get_credentials_renew\fR
522 .in -2
524 .in +2
525 \fBkrb5_get_credentials_validate\fR
526 .in -2
528 .in +2
529 \fBkrb5_get_default_realm\fR
530 .in -2
532 .in +2
533 \fBkrb5_get_host_realm\fR
534 .in -2
536 .in +2
537 \fBkrb5_get_init_creds_keytab\fR
538 .in -2
540 .in +2
541 \fBkrb5_get_init_creds_opt_init\fR
542 .in -2
544 .in +2
545 \fBkrb5_get_init_creds_opt_set_address_list\fR
546 .in -2
548 .in +2
549 \fBkrb5_get_init_creds_opt_set_etype_list\fR
550 .in -2
552 .in +2
553 \fBkrb5_get_init_creds_opt_set_forwardable\fR
554 .in -2
556 .in +2
557 \fBkrb5_get_init_creds_opt_set_preauth_list\fR
558 .in -2
560 .in +2
561 \fBkrb5_get_init_creds_opt_set_proxiable\fR
562 .in -2
564 .in +2
565 \fBkrb5_get_init_creds_opt_set_renew_life\fR
566 .in -2
568 .in +2
569 \fBkrb5_get_init_creds_opt_set_salt\fR
570 .in -2
572 .in +2
573 \fBkrb5_get_init_creds_opt_set_tkt_life\fR
574 .in -2
576 .in +2
577 \fBkrb5_get_key_data\fR
578 .in -2
580 .in +2
581 \fBkrb5_get_key_enctype\fR
582 .in -2
584 .in +2
585 \fBkrb5_get_key_length\fR
586 .in -2
588 .in +2
589 \fBkrb5_get_init_creds_password\fR
590 .in -2
592 .in +2
593 \fBkrb5_get_permitted_enctypes\fR
594 .in -2
596 .in +2
597 \fBkrb5_get_profile\fR
598 .in -2
600 .in +2
601 \fBkrb5_get_prompt_types\fR
602 .in -2
604 .in +2
605 \fBkrb5_get_renewed_creds\fR
606 .in -2
608 .in +2
609 \fBkrb5_get_server_rcache\fR
610 .in -2
612 .in +2
613 \fBkrb5_get_validated_creds\fR
614 .in -2
616 .in +2
617 \fBkrb5_init_allocated_keyblock\fR
618 .in -2
620 .in +2
621 \fBkrb5_init_context\fR
622 .in -2
624 .in +2
625 \fBkrb5_init_keyblock\fR
626 .in -2
628 .in +2
629 \fBkrb5_init_secure_context\fR
630 .in -2
632 .in +2
633 \fBkrb5_is_thread_safe\fR
634 .in -2
636 .in +2
637 \fBkrb5_kt_add_entry\fR
638 .in -2
640 .in +2
641 \fBkrb5_kt_close\fR
642 .in -2
644 .in +2
645 \fBkrb5_kt_default\fR
646 .in -2
648 .in +2
649 \fBkrb5_kt_default_name\fR
650 .in -2
652 .in +2
653 \fBkrb5_kt_end_seq_get\fR
654 .in -2
656 .in +2
657 \fBkrb5_kt_get_entry\fR
658 .in -2
660 .in +2
661 \fBkrb5_kt_get_name\fR
662 .in -2
664 .in +2
665 \fBkrb5_kt_get_type\fR
666 .in -2
668 .in +2
669 \fBkrb5_kt_next_entry\fR
670 .in -2
672 .in +2
673 \fBkrb5_kt_read_service_key\fR
674 .in -2
676 .in +2
677 \fBkrb5_kt_remove_entry\fR
678 .in -2
680 .in +2
681 \fBkrb5_kt_resolve\fR
682 .in -2
684 .in +2
685 \fBkrb5_kt_start_seq_get\fR
686 .in -2
688 .in +2
689 \fBkrb5_kuserok\fR
690 .in -2
692 .in +2
693 \fBkrb5_mk_error\fR
694 .in -2
696 .in +2
697 \fBkrb5_mk_ncred\fR
698 .in -2
700 .in +2
701 \fBkrb5_mk_priv\fR
702 .in -2
704 .in +2
705 \fBkrb5_mk_rep\fR
706 .in -2
708 .in +2
709 \fBkrb5_mk_req\fR
710 .in -2
712 .in +2
713 \fBkrb5_mk_req_extended\fR
714 .in -2
716 .in +2
717 \fBkrb5_mk_safe\fR
718 .in -2
720 .in +2
721 \fBkrb5_mk_1cred\fR
722 .in -2
724 .in +2
725 \fBkrb5_os_localaddr\fR
726 .in -2
728 .in +2
729 \fBkrb5_pac_add_buffer\fR
730 .in -2
732 .in +2
733 \fBkrb5_pac_free\fR
734 .in -2
736 .in +2
737 \fBkrb5_pac_get_types\fR
738 .in -2
740 .in +2
741 \fBkrb5_pac_get_buffer\fR
742 .in -2
744 .in +2
745 \fBkrb5_pac_init\fR
746 .in -2
748 .in +2
749 \fBkrb5_pac_parse\fR
750 .in -2
752 .in +2
753 \fBkrb5_pac_verify\fR
754 .in -2
756 .in +2
757 \fBkrb5_parse_name\fR
758 .in -2
760 .in +2
761 \fBkrb5_principal_compare\fR
762 .in -2
764 .in +2
765 \fBkrb5_principal2salt\fR
766 .in -2
768 .in +2
769 \fBkrb5_prompter_posix\fR
770 .in -2
772 .in +2
773 \fBkrb5_rd_cred\fR
774 .in -2
776 .in +2
777 \fBkrb5_rd_error\fR
778 .in -2
780 .in +2
781 \fBkrb5_rd_priv\fR
782 .in -2
784 .in +2
785 \fBkrb5_rd_rep\fR
786 .in -2
788 .in +2
789 \fBkrb5_rd_req\fR
790 .in -2
792 .in +2
793 \fBkrb5_rd_safe\fR
794 .in -2
796 .in +2
797 \fBkrb5_read_password\fR
798 .in -2
800 .in +2
801 \fBkrb5_realm_compare\fR
802 .in -2
804 .in +2
805 \fBkrb5_realm_iterator\fR
806 .in -2
808 .in +2
809 \fBkrb5_realm_iterator_create\fR
810 .in -2
812 .in +2
813 \fBkrb5_realm_iterator_free\fR
814 .in -2
816 .in +2
817 \fBkrb5_recvauth\fR
818 .in -2
820 .in +2
821 \fBkrb5_recvauth_version\fR
822 .in -2
824 .in +2
825 \fBkrb5_salttype_to_string\fR
826 .in -2
828 .in +2
829 \fBkrb5_sendauth\fR
830 .in -2
832 .in +2
833 \fBkrb5_set_default_realm\fR
834 .in -2
836 .in +2
837 \fBkrb5_set_default_tgs_enctypes\fR
838 .in -2
840 .in +2
841 \fBkrb5_set_key_data\fR
842 .in -2
844 .in +2
845 \fBkrb5_set_key_enctype\fR
846 .in -2
848 .in +2
849 \fBkrb5_set_key_length\fR
850 .in -2
852 .in +2
853 \fBkrb5_set_password\fR
854 .in -2
856 .in +2
857 \fBkrb5_set_password_using_ccache\fR
858 .in -2
860 .in +2
861 \fBkrb5_set_principal_realm\fR
862 .in -2
864 .in +2
865 \fBkrb5_set_real_time\fR
866 .in -2
868 .in +2
869 \fBkrb5_sname_to_principal\fR
870 .in -2
872 .in +2
873 \fBkrb5_string_to_cksumtype\fR
874 .in -2
876 .in +2
877 \fBkrb5_string_to_deltat\fR
878 .in -2
880 .in +2
881 \fBkrb5_string_to_enctype\fR
882 .in -2
884 .in +2
885 \fBkrb5_string_to_key\fR
886 .in -2
888 .in +2
889 \fBkrb5_string_to_salttype\fR
890 .in -2
892 .in +2
893 \fBkrb5_string_to_timestamp\fR
894 .in -2
896 .in +2
897 \fBkrb5_timeofday\fR
898 .in -2
900 .in +2
901 \fBkrb5_timestamp_to_sfstring\fR
902 .in -2
904 .in +2
905 \fBkrb5_timestamp_to_string\fR
906 .in -2
908 .in +2
909 \fBkrb5_unparse_name\fR
910 .in -2
912 .in +2
913 \fBkrb5_unparse_name_ext\fR
914 .in -2
916 .in +2
917 \fBkrb5_us_timeofday\fR
918 .in -2
920 .in +2
921 \fBkrb5_use_enctype\fR
922 .in -2
924 .in +2
925 \fBkrb5_verify_init_creds\fR
926 .in -2
928 .in +2
929 \fBkrb5_verify_init_creds_opt_init\fR
930 .in -2
932 .in +2
933 \fBkrb5_verify_init_creds_opt_set_ap_req_nofail\fR
934 .in -2
936 .in +2
937 \fBkrb5_xfree\fR
938 .in -2
940 .in +2
941 \fBkrb5_xfree_wrap\fR
942 .in -2
943 .SH FILES
944 .ne 2
946 \fB\fB/usr/lib/libkrb5.so.1\fR\fR
948 .RS 28n
949 shared object
953 .ne 2
955 \fB\fB/usr/lib/64/libkrb5.so.1\fR\fR
957 .RS 28n
958 64-bit shared object
961 .SH ATTRIBUTES
963 See \fBattributes\fR(5) for descriptions of the following attributes:
968 box;
969 c | c
970 l | l .
971 ATTRIBUTE TYPE  ATTRIBUTE VALUE
973 Interface Stability     Volatile
975 MT-Level        Safe
978 .SH SEE ALSO
980 \fBkrb5-config\fR(1), \fBlibgss\fR(3LIB), \fBattributes\fR(5)