1
.TH "Heimdal Kerberos 5 library" 3 "30 Jul 2011" "Version 1.5" "HeimdalKerberos5library" \" -*- nroff -*-
5
Heimdal Kerberos 5 library \-
10
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_et_list\fP (krb5_context context, void(*func)(struct et_list **))"
13
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_password\fP (krb5_context context, krb5_creds *creds, const char *newpw, krb5_principal targprinc, int *result_code, krb5_data *result_code_string, krb5_data *result_string)"
16
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_init_context\fP (krb5_context *context)"
19
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_context\fP (krb5_context context, krb5_context *out)"
22
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_context\fP (krb5_context context)"
25
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_config_files\fP (krb5_context context, char **filenames)"
28
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_prepend_config_files_default\fP (const char *filelist, char ***pfilenames)"
31
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_default_config_files\fP (char ***pfilenames)"
34
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_config_files\fP (char **filenames)"
37
.RI "KRB5_LIB_FUNCTION const krb5_enctype *KRB5_LIB_CALL \fBkrb5_kerberos_enctypes\fP (krb5_context context)"
40
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_default_in_tkt_etypes\fP (krb5_context context, const krb5_enctype *etypes)"
43
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_default_in_tkt_etypes\fP (krb5_context context, krb5_pdu pdu_type, krb5_enctype **etypes)"
46
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_init_ets\fP (krb5_context context)"
49
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_use_admin_kdc\fP (krb5_context context, krb5_boolean flag)"
52
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_get_use_admin_kdc\fP (krb5_context context)"
55
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_extra_addresses\fP (krb5_context context, krb5_addresses *addresses)"
58
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_extra_addresses\fP (krb5_context context, const krb5_addresses *addresses)"
61
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_extra_addresses\fP (krb5_context context, krb5_addresses *addresses)"
64
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_ignore_addresses\fP (krb5_context context, krb5_addresses *addresses)"
67
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_ignore_addresses\fP (krb5_context context, const krb5_addresses *addresses)"
70
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_ignore_addresses\fP (krb5_context context, krb5_addresses *addresses)"
73
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_fcache_version\fP (krb5_context context, int version)"
76
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_fcache_version\fP (krb5_context context, int *version)"
79
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_is_thread_safe\fP (void)"
82
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_dns_canonicalize_hostname\fP (krb5_context context, krb5_boolean flag)"
85
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_get_dns_canonicalize_hostname\fP (krb5_context context)"
88
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_kdc_sec_offset\fP (krb5_context context, int32_t *sec, int32_t *usec)"
91
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_kdc_sec_offset\fP (krb5_context context, int32_t sec, int32_t usec)"
94
.RI "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL \fBkrb5_get_max_time_skew\fP (krb5_context context)"
97
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_max_time_skew\fP (krb5_context context, time_t t)"
100
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_set_home_dir_access\fP (krb5_context context, krb5_boolean allow)"
103
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_host_realm\fP (krb5_context context, const krb5_realm *from, krb5_realm **to)"
106
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_cred_contents\fP (krb5_context context, krb5_creds *c)"
109
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_creds_contents\fP (krb5_context context, const krb5_creds *incred, krb5_creds *c)"
112
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_creds\fP (krb5_context context, const krb5_creds *incred, krb5_creds **outcred)"
115
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_creds\fP (krb5_context context, krb5_creds *c)"
118
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_compare_creds\fP (krb5_context context, krb5_flags whichfields, const krb5_creds *mcreds, const krb5_creds *creds)"
121
.RI "KRB5_LIB_FUNCTION unsigned long KRB5_LIB_CALL \fBkrb5_creds_get_ticket_flags\fP (krb5_creds *creds)"
124
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_data_zero\fP (krb5_data *p)"
127
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_data_free\fP (krb5_data *p)"
130
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_data\fP (krb5_context context, krb5_data *p)"
133
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_alloc\fP (krb5_data *p, int len)"
136
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_realloc\fP (krb5_data *p, int len)"
139
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_copy\fP (krb5_data *p, const void *data, size_t len)"
142
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_data\fP (krb5_context context, const krb5_data *indata, krb5_data **outdata)"
145
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_data_cmp\fP (const krb5_data *data1, const krb5_data *data2)"
148
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_data_ct_cmp\fP (const krb5_data *data1, const krb5_data *data2)"
151
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_krbhst_get_addrinfo\fP (krb5_context context, krb5_krbhst_info *host, struct addrinfo **ai)"
154
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_ticket\fP (krb5_context context, krb5_ticket *ticket)"
157
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_ticket\fP (krb5_context context, const krb5_ticket *from, krb5_ticket **to)"
160
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ticket_get_client\fP (krb5_context context, const krb5_ticket *ticket, krb5_principal *client)"
163
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ticket_get_server\fP (krb5_context context, const krb5_ticket *ticket, krb5_principal *server)"
166
.RI "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL \fBkrb5_ticket_get_endtime\fP (krb5_context context, const krb5_ticket *ticket)"
169
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ticket_get_authorization_data_type\fP (krb5_context context, krb5_ticket *ticket, int type, krb5_data *data)"
172
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_real_time\fP (krb5_context context, krb5_timestamp sec, int32_t usec)"
175
.SH "Detailed Description"
178
.SH "Function Documentation"
180
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_et_list (krb5_context context, void(*)(struct et_list **) func)"
182
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.
186
\fIcontext\fP A kerberos context.
188
\fIfunc\fP The generated com_err et function.
193
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
197
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_extra_addresses (krb5_context context, krb5_addresses * addresses)"
199
Add extra address to the address list that the library will add to the client's address list when communicating with the KDC.
203
\fIcontext\fP Kerberos 5 context.
205
\fIaddresses\fP addreses to add
210
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
214
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_ignore_addresses (krb5_context context, krb5_addresses * addresses)"
216
Add extra addresses to ignore when fetching addresses from the underlaying operating system.
220
\fIcontext\fP Kerberos 5 context.
222
\fIaddresses\fP addreses to ignore
227
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
231
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_compare_creds (krb5_context context, krb5_flags whichfields, const krb5_creds * mcreds, const krb5_creds * creds)"
233
Return TRUE if `mcreds' and `creds' are equal (`whichfields' determines what equal means).
235
The following flags, set in whichfields affects the comparison:
237
KRB5_TC_MATCH_SRV_NAMEONLY Consider all realms equal when comparing the service principal.
239
KRB5_TC_MATCH_KEYTYPE Compare enctypes.
241
KRB5_TC_MATCH_FLAGS_EXACT Make sure that the ticket flags are identical.
243
KRB5_TC_MATCH_FLAGS Make sure that all ticket flags set in mcreds are also present in creds .
245
KRB5_TC_MATCH_TIMES_EXACT Compares the ticket times exactly.
247
KRB5_TC_MATCH_TIMES Compares only the expiration times of the creds.
249
KRB5_TC_MATCH_AUTHDATA Compares the authdata fields.
251
KRB5_TC_MATCH_2ND_TKT Compares the second tickets (used by user-to-user authentication).
253
KRB5_TC_MATCH_IS_SKEY Compares the existance of the second ticket.
258
\fIcontext\fP Kerberos 5 context.
260
\fIwhichfields\fP which fields to compare.
262
\fImcreds\fP cred to compare with.
264
\fIcreds\fP cred to compare with.
269
return TRUE if mcred and creds are equal, FALSE if not.
273
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_context (krb5_context context, krb5_context * out)"
275
Make a copy for the Kerberos 5 context, the new krb5_context shoud be freed with \fBkrb5_free_context()\fP.
279
\fIcontext\fP the Kerberos context to copy
281
\fIout\fP the copy of the Kerberos, set to NULL error.
286
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
290
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds (krb5_context context, const krb5_creds * incred, krb5_creds ** outcred)"
296
\fIcontext\fP Kerberos 5 context.
298
\fIincred\fP source credential
300
\fIoutcred\fP destination credential, free with \fBkrb5_free_creds()\fP.
305
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
309
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds_contents (krb5_context context, const krb5_creds * incred, krb5_creds * c)"
311
Copy content of krb5_creds.
315
\fIcontext\fP Kerberos 5 context.
317
\fIincred\fP source credential
319
\fIc\fP destination credential, free with \fBkrb5_free_cred_contents()\fP.
324
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
328
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_data (krb5_context context, const krb5_data * indata, krb5_data ** outdata)"
330
Copy the data into a newly allocated krb5_data.
334
\fIcontext\fP Kerberos 5 context.
336
\fIindata\fP the krb5_data data to copy
338
\fIoutdata\fP new krb5_date to copy too. Free with \fBkrb5_free_data()\fP.
343
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
347
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_host_realm (krb5_context context, const krb5_realm * from, krb5_realm ** to)"
349
Copy the list of realms from `from' to `to'.
353
\fIcontext\fP Kerberos 5 context.
355
\fIfrom\fP list of realms to copy from.
357
\fIto\fP list of realms to copy to, free list of \fBkrb5_free_host_realm()\fP.
362
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
366
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_ticket (krb5_context context, const krb5_ticket * from, krb5_ticket ** to)"
368
Copy ticket and content
372
\fIcontext\fP a Kerberos 5 context
374
\fIfrom\fP ticket to copy
376
\fIto\fP new copy of ticket, free with \fBkrb5_free_ticket()\fP
381
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
385
.SS "KRB5_LIB_FUNCTION unsigned long KRB5_LIB_CALL krb5_creds_get_ticket_flags (krb5_creds * creds)"
387
Returns the ticket flags for the credentials in creds. See also \fBkrb5_ticket_get_flags()\fP.
391
\fIcreds\fP credential to get ticket flags from
400
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_alloc (krb5_data * p, int len)"
402
Allocate data of and krb5_data.
406
\fIp\fP krb5_data to allocate.
408
\fIlen\fP size to allocate.
413
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
417
.SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_cmp (const krb5_data * data1, const krb5_data * data2)"
423
\fIdata1\fP krb5_data to compare
425
\fIdata2\fP krb5_data to compare
430
return the same way as memcmp(), useful when sorting.
434
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_copy (krb5_data * p, const void * data, size_t len)"
436
Copy the data of len into the krb5_data.
440
\fIp\fP krb5_data to copy into.
442
\fIdata\fP data to copy..
449
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
453
.SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_ct_cmp (const krb5_data * data1, const krb5_data * data2)"
455
Compare to data not exposing timing information from the checksum data
459
\fIdata1\fP krb5_data to compare
461
\fIdata2\fP krb5_data to compare
466
returns zero for same data, otherwise non zero.
470
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_free (krb5_data * p)"
472
Free the content of krb5_data structure, its ok to free a zeroed structure (with memset() or \fBkrb5_data_zero()\fP). When done, the structure will be zeroed. The same function is called \fBkrb5_free_data_contents()\fP in MIT Kerberos.
476
\fIp\fP krb5_data to free.
480
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_realloc (krb5_data * p, int len)"
482
Grow (or shrink) the content of krb5_data to a new size.
486
\fIp\fP krb5_data to free.
493
Returns 0 to indicate success. Otherwise an kerberos et error code is returned.
497
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_zero (krb5_data * p)"
499
Reset the (potentially uninitalized) krb5_data structure.
503
\fIp\fP krb5_data to reset.
507
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_config_files (char ** filenames)"
509
Free a list of configuration files.
513
\fIfilenames\fP list, terminated with a NULL pointer, to be freed. NULL is an valid argument.
518
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
522
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_context (krb5_context context)"
524
Frees the krb5_context allocated by \fBkrb5_init_context()\fP.
528
\fIcontext\fP context to be freed.
532
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_cred_contents (krb5_context context, krb5_creds * c)"
534
Free content of krb5_creds.
538
\fIcontext\fP Kerberos 5 context.
540
\fIc\fP krb5_creds to free.
545
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
549
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_creds (krb5_context context, krb5_creds * c)"
555
\fIcontext\fP Kerberos 5 context.
557
\fIc\fP krb5_creds to free.
562
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
566
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_data (krb5_context context, krb5_data * p)"
568
Free krb5_data (and its content).
572
\fIcontext\fP Kerberos 5 context.
574
\fIp\fP krb5_data to free.
578
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_ticket (krb5_context context, krb5_ticket * ticket)"
580
Free ticket and content
584
\fIcontext\fP a Kerberos 5 context
586
\fIticket\fP ticket to free
591
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
595
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_default_config_files (char *** pfilenames)"
597
Get the global configuration list.
601
\fIpfilenames\fP return array of filenames, should be freed with \fBkrb5_free_config_files()\fP.
606
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
610
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_default_in_tkt_etypes (krb5_context context, krb5_pdu pdu_type, krb5_enctype ** etypes)"
612
Get the default encryption types that will be use in communcation with the KDC, clients and servers.
616
\fIcontext\fP Kerberos 5 context.
618
\fIetypes\fP Encryption types, array terminated with ETYPE_NULL(0), caller should free array with krb5_xfree():
623
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
627
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_dns_canonicalize_hostname (krb5_context context)"
629
Get if the library uses DNS to canonicalize hostnames.
633
\fIcontext\fP Kerberos 5 context.
638
return non zero if the library uses DNS to canonicalize hostnames.
642
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_extra_addresses (krb5_context context, krb5_addresses * addresses)"
644
Get extra address to the address list that the library will add to the client's address list when communicating with the KDC.
648
\fIcontext\fP Kerberos 5 context.
650
\fIaddresses\fP addreses to set
655
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
659
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_fcache_version (krb5_context context, int * version)"
661
Get version of fcache that the library should use.
665
\fIcontext\fP Kerberos 5 context.
667
\fIversion\fP version number.
672
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
676
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_ignore_addresses (krb5_context context, krb5_addresses * addresses)"
678
Get extra addresses to ignore when fetching addresses from the underlaying operating system.
682
\fIcontext\fP Kerberos 5 context.
684
\fIaddresses\fP list addreses ignored
689
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
693
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_kdc_sec_offset (krb5_context context, int32_t * sec, int32_t * usec)"
695
Get current offset in time to the KDC.
699
\fIcontext\fP Kerberos 5 context.
701
\fIsec\fP seconds part of offset.
703
\fIusec\fP micro seconds part of offset.
712
.SS "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_get_max_time_skew (krb5_context context)"
714
Get max time skew allowed.
718
\fIcontext\fP Kerberos 5 context.
727
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_use_admin_kdc (krb5_context context)"
729
Make the kerberos library default to the admin KDC.
733
\fIcontext\fP Kerberos 5 context.
738
boolean flag to telling the context will use admin KDC as the default KDC.
742
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_context (krb5_context * context)"
744
Initializes the context structure and reads the configuration file /etc/krb5.conf. The structure should be freed by calling \fBkrb5_free_context()\fP when it is no longer being used.
748
\fIcontext\fP pointer to returned context
753
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.
757
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_ets (krb5_context context)"
759
Init the built-in ets in the Kerberos library.
763
\fIcontext\fP kerberos context to add the ets too
767
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_is_thread_safe (void)"
769
Runtime check if the Kerberos library was complied with thread support.
773
TRUE if the library was compiled with thread support, FALSE if not.
777
.SS "KRB5_LIB_FUNCTION const krb5_enctype* KRB5_LIB_CALL krb5_kerberos_enctypes (krb5_context context)"
779
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 \fBkrb5_enctype_valid()\fP before using the encryption type.
783
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.
787
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_krbhst_get_addrinfo (krb5_context context, krb5_krbhst_info * host, struct addrinfo ** ai)"
789
Return an `struct addrinfo *' for a KDC host.
791
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.
793
First try this as an IP address, this allows us to add a dot at the end to stop using the search domains.
795
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.
796
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_prepend_config_files_default (const char * filelist, char *** pfilenames)"
798
Prepend the filename to the global configuration list.
802
\fIfilelist\fP a filename to add to the default list of filename
804
\fIpfilenames\fP return array of filenames, should be freed with \fBkrb5_free_config_files()\fP.
809
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
813
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_config_files (krb5_context context, char ** filenames)"
815
Reinit the context from a new set of filenames.
819
\fIcontext\fP context to add configuration too.
821
\fIfilenames\fP array of filenames, end of list is indicated with a NULL filename.
826
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
830
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_default_in_tkt_etypes (krb5_context context, const krb5_enctype * etypes)"
832
Set the default encryption types that will be use in communcation with the KDC, clients and servers.
836
\fIcontext\fP Kerberos 5 context.
838
\fIetypes\fP Encryption types, array terminated with ETYPE_NULL (0).
843
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
847
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)"
849
Set if the library should use DNS to canonicalize hostnames.
853
\fIcontext\fP Kerberos 5 context.
855
\fIflag\fP if its dns canonicalizion is used or not.
859
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_extra_addresses (krb5_context context, const krb5_addresses * addresses)"
861
Set extra address to the address list that the library will add to the client's address list when communicating with the KDC.
865
\fIcontext\fP Kerberos 5 context.
867
\fIaddresses\fP addreses to set
872
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
876
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_fcache_version (krb5_context context, int version)"
878
Set version of fcache that the library should use.
882
\fIcontext\fP Kerberos 5 context.
884
\fIversion\fP version number.
889
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
893
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_set_home_dir_access (krb5_context context, krb5_boolean allow)"
895
Enable and disable home directory access on either the global state or the krb5_context state. By calling \fBkrb5_set_home_dir_access()\fP with context set to NULL, the global state is configured otherwise the state for the krb5_context is modified.
897
For home directory access to be allowed, both the global state and the krb5_context state have to be allowed.
899
Administrator (root user), never uses the home directory.
903
\fIcontext\fP a Kerberos 5 context or NULL
905
\fIallow\fP allow if TRUE home directory
914
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_ignore_addresses (krb5_context context, const krb5_addresses * addresses)"
916
Set extra addresses to ignore when fetching addresses from the underlaying operating system.
920
\fIcontext\fP Kerberos 5 context.
922
\fIaddresses\fP addreses to ignore
927
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
931
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_kdc_sec_offset (krb5_context context, int32_t sec, int32_t usec)"
933
Set current offset in time to the KDC.
937
\fIcontext\fP Kerberos 5 context.
939
\fIsec\fP seconds part of offset.
941
\fIusec\fP micro seconds part of offset.
950
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_max_time_skew (krb5_context context, time_t t)"
952
Set max time skew allowed.
956
\fIcontext\fP Kerberos 5 context.
958
\fIt\fP timeskew in seconds.
962
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_password (krb5_context context, krb5_creds * creds, const char * newpw, krb5_principal targprinc, int * result_code, krb5_data * result_code_string, krb5_data * result_string)"
964
Change password using creds.
968
\fIcontext\fP a Keberos context
970
\fIcreds\fP The initial kadmin/passwd for the principal or an admin principal
972
\fInewpw\fP The new password to set
974
\fItargprinc\fP if unset, the default principal is used.
976
\fIresult_code\fP Result code, KRB5_KPASSWD_SUCCESS is when password is changed.
978
\fIresult_code_string\fP binary message from the server, contains at least the result_code.
980
\fIresult_string\fP A message from the kpasswd service or the library in human printable form. The string is NUL terminated.
985
On sucess and *result_code is KRB5_KPASSWD_SUCCESS, the password is changed.
989
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_real_time (krb5_context context, krb5_timestamp sec, int32_t usec)"
991
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.
995
\fIcontext\fP Keberos 5 context.
997
\fIsec\fP The applications new of 'now' in seconds
999
\fIusec\fP The applications new of 'now' in micro seconds
1004
Kerberos 5 error code, see krb5_get_error_message().
1009
If the caller passes in a negative usec, its assumed to be unknown and the function will use the current time usec.
1010
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)"
1012
Make the kerberos library default to the admin KDC.
1016
\fIcontext\fP Kerberos 5 context.
1018
\fIflag\fP boolean flag to select if the use the admin KDC or not.
1022
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_authorization_data_type (krb5_context context, krb5_ticket * ticket, int type, krb5_data * data)"
1024
Extract the authorization data type of type from the ticket. Store the field in data. This function is to use for kerberos applications.
1028
\fIcontext\fP a Kerberos 5 context
1030
\fIticket\fP Kerberos ticket
1032
\fItype\fP type to fetch
1034
\fIdata\fP returned data, free with \fBkrb5_data_free()\fP
1038
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_client (krb5_context context, const krb5_ticket * ticket, krb5_principal * client)"
1040
Return client principal in ticket
1044
\fIcontext\fP a Kerberos 5 context
1046
\fIticket\fP ticket to copy
1048
\fIclient\fP client principal, free with \fBkrb5_free_principal()\fP
1053
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
1057
.SS "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_ticket_get_endtime (krb5_context context, const krb5_ticket * ticket)"
1059
Return end time of ticket
1063
\fIcontext\fP a Kerberos 5 context
1065
\fIticket\fP ticket to copy
1074
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_server (krb5_context context, const krb5_ticket * ticket, krb5_principal * server)"
1076
Return server principal in ticket
1080
\fIcontext\fP a Kerberos 5 context
1082
\fIticket\fP ticket to copy
1084
\fIserver\fP server principal, free with \fBkrb5_free_principal()\fP
1089
Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message().
added
removed
doc/doxyout/krb5/man/man3/krb5.3
