]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - crypto/heimdal/doc/doxyout/krb5/man/man3/krb5.3
Avoid printing extraneous function names when searching man page
[FreeBSD/stable/10.git] / crypto / heimdal / doc / doxyout / krb5 / man / man3 / krb5.3
1 .TH "Heimdal Kerberos 5 library" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 krb5 \- Heimdal Kerberos 5 library
6 .SH SYNOPSIS
7 .in +1c
8 .ti -1c
9 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_et_list\fP (krb5_context context, void(*func)(struct et_list **))"
10 .br
11 .ti -1c
12 .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)"
13 .br
14 .ti -1c
15 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_init_context\fP (krb5_context *context)"
16 .br
17 .ti -1c
18 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_context\fP (krb5_context context, krb5_context *out)"
19 .br
20 .ti -1c
21 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_context\fP (krb5_context context)"
22 .br
23 .ti -1c
24 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_config_files\fP (krb5_context context, char **filenames)"
25 .br
26 .ti -1c
27 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_prepend_config_files_default\fP (const char *filelist, char ***pfilenames)"
28 .br
29 .ti -1c
30 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_default_config_files\fP (char ***pfilenames)"
31 .br
32 .ti -1c
33 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_config_files\fP (char **filenames)"
34 .br
35 .ti -1c
36 .RI "KRB5_LIB_FUNCTION const krb5_enctype *KRB5_LIB_CALL \fBkrb5_kerberos_enctypes\fP (krb5_context context)"
37 .br
38 .ti -1c
39 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_default_in_tkt_etypes\fP (krb5_context context, const krb5_enctype *etypes)"
40 .br
41 .ti -1c
42 .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)"
43 .br
44 .ti -1c
45 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_init_ets\fP (krb5_context context)"
46 .br
47 .ti -1c
48 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_use_admin_kdc\fP (krb5_context context, krb5_boolean flag)"
49 .br
50 .ti -1c
51 .RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_get_use_admin_kdc\fP (krb5_context context)"
52 .br
53 .ti -1c
54 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_extra_addresses\fP (krb5_context context, krb5_addresses *addresses)"
55 .br
56 .ti -1c
57 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_extra_addresses\fP (krb5_context context, const krb5_addresses *addresses)"
58 .br
59 .ti -1c
60 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_extra_addresses\fP (krb5_context context, krb5_addresses *addresses)"
61 .br
62 .ti -1c
63 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_add_ignore_addresses\fP (krb5_context context, krb5_addresses *addresses)"
64 .br
65 .ti -1c
66 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_ignore_addresses\fP (krb5_context context, const krb5_addresses *addresses)"
67 .br
68 .ti -1c
69 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_ignore_addresses\fP (krb5_context context, krb5_addresses *addresses)"
70 .br
71 .ti -1c
72 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_fcache_version\fP (krb5_context context, int version)"
73 .br
74 .ti -1c
75 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_get_fcache_version\fP (krb5_context context, int *version)"
76 .br
77 .ti -1c
78 .RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_is_thread_safe\fP (void)"
79 .br
80 .ti -1c
81 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_dns_canonicalize_hostname\fP (krb5_context context, krb5_boolean flag)"
82 .br
83 .ti -1c
84 .RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_get_dns_canonicalize_hostname\fP (krb5_context context)"
85 .br
86 .ti -1c
87 .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)"
88 .br
89 .ti -1c
90 .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)"
91 .br
92 .ti -1c
93 .RI "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL \fBkrb5_get_max_time_skew\fP (krb5_context context)"
94 .br
95 .ti -1c
96 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_max_time_skew\fP (krb5_context context, time_t t)"
97 .br
98 .ti -1c
99 .RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_set_home_dir_access\fP (krb5_context context, krb5_boolean allow)"
100 .br
101 .ti -1c
102 .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)"
103 .br
104 .ti -1c
105 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_cred_contents\fP (krb5_context context, krb5_creds *c)"
106 .br
107 .ti -1c
108 .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)"
109 .br
110 .ti -1c
111 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_creds\fP (krb5_context context, const krb5_creds *incred, krb5_creds **outcred)"
112 .br
113 .ti -1c
114 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_creds\fP (krb5_context context, krb5_creds *c)"
115 .br
116 .ti -1c
117 .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)"
118 .br
119 .ti -1c
120 .RI "KRB5_LIB_FUNCTION unsigned long KRB5_LIB_CALL \fBkrb5_creds_get_ticket_flags\fP (krb5_creds *creds)"
121 .br
122 .ti -1c
123 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_data_zero\fP (krb5_data *p)"
124 .br
125 .ti -1c
126 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_data_free\fP (krb5_data *p)"
127 .br
128 .ti -1c
129 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_data\fP (krb5_context context, krb5_data *p)"
130 .br
131 .ti -1c
132 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_alloc\fP (krb5_data *p, int len)"
133 .br
134 .ti -1c
135 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_realloc\fP (krb5_data *p, int len)"
136 .br
137 .ti -1c
138 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_data_copy\fP (krb5_data *p, const void *data, size_t len)"
139 .br
140 .ti -1c
141 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_data\fP (krb5_context context, const krb5_data *indata, krb5_data **outdata)"
142 .br
143 .ti -1c
144 .RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_data_cmp\fP (const krb5_data *data1, const krb5_data *data2)"
145 .br
146 .ti -1c
147 .RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_data_ct_cmp\fP (const krb5_data *data1, const krb5_data *data2)"
148 .br
149 .ti -1c
150 .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)"
151 .br
152 .ti -1c
153 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_free_ticket\fP (krb5_context context, krb5_ticket *ticket)"
154 .br
155 .ti -1c
156 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_copy_ticket\fP (krb5_context context, const krb5_ticket *from, krb5_ticket **to)"
157 .br
158 .ti -1c
159 .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)"
160 .br
161 .ti -1c
162 .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)"
163 .br
164 .ti -1c
165 .RI "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL \fBkrb5_ticket_get_endtime\fP (krb5_context context, const krb5_ticket *ticket)"
166 .br
167 .ti -1c
168 .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)"
169 .br
170 .ti -1c
171 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_real_time\fP (krb5_context context, krb5_timestamp sec, int32_t usec)"
172 .br
173 .in -1c
174 .SH "Detailed Description"
175 .PP 
176
177 .SH "Function Documentation"
178 .PP 
179 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_et_list (krb5_context context, void(*)(struct et_list **) func)"
180 .PP
181 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.
182 .PP
183 \fBParameters:\fP
184 .RS 4
185 \fIcontext\fP A kerberos context. 
186 .br
187 \fIfunc\fP The generated com_err et function.
188 .RE
189 .PP
190 \fBReturns:\fP
191 .RS 4
192 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
193 .RE
194 .PP
195
196 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_extra_addresses (krb5_context context, krb5_addresses * addresses)"
197 .PP
198 Add extra address to the address list that the library will add to the client's address list when communicating with the KDC.
199 .PP
200 \fBParameters:\fP
201 .RS 4
202 \fIcontext\fP Kerberos 5 context. 
203 .br
204 \fIaddresses\fP addreses to add
205 .RE
206 .PP
207 \fBReturns:\fP
208 .RS 4
209 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
210 .RE
211 .PP
212
213 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_add_ignore_addresses (krb5_context context, krb5_addresses * addresses)"
214 .PP
215 Add extra addresses to ignore when fetching addresses from the underlaying operating system.
216 .PP
217 \fBParameters:\fP
218 .RS 4
219 \fIcontext\fP Kerberos 5 context. 
220 .br
221 \fIaddresses\fP addreses to ignore
222 .RE
223 .PP
224 \fBReturns:\fP
225 .RS 4
226 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
227 .RE
228 .PP
229
230 .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)"
231 .PP
232 Return TRUE if `mcreds' and `creds' are equal (`whichfields' determines what equal means).
233 .PP
234 The following flags, set in whichfields affects the comparison:
235 .IP "\(bu" 2
236 KRB5_TC_MATCH_SRV_NAMEONLY Consider all realms equal when comparing the service principal.
237 .IP "\(bu" 2
238 KRB5_TC_MATCH_KEYTYPE Compare enctypes.
239 .IP "\(bu" 2
240 KRB5_TC_MATCH_FLAGS_EXACT Make sure that the ticket flags are identical.
241 .IP "\(bu" 2
242 KRB5_TC_MATCH_FLAGS Make sure that all ticket flags set in mcreds are also present in creds .
243 .IP "\(bu" 2
244 KRB5_TC_MATCH_TIMES_EXACT Compares the ticket times exactly.
245 .IP "\(bu" 2
246 KRB5_TC_MATCH_TIMES Compares only the expiration times of the creds.
247 .IP "\(bu" 2
248 KRB5_TC_MATCH_AUTHDATA Compares the authdata fields.
249 .IP "\(bu" 2
250 KRB5_TC_MATCH_2ND_TKT Compares the second tickets (used by user-to-user authentication).
251 .IP "\(bu" 2
252 KRB5_TC_MATCH_IS_SKEY Compares the existance of the second ticket.
253 .PP
254 .PP
255 \fBParameters:\fP
256 .RS 4
257 \fIcontext\fP Kerberos 5 context. 
258 .br
259 \fIwhichfields\fP which fields to compare. 
260 .br
261 \fImcreds\fP cred to compare with. 
262 .br
263 \fIcreds\fP cred to compare with.
264 .RE
265 .PP
266 \fBReturns:\fP
267 .RS 4
268 return TRUE if mcred and creds are equal, FALSE if not. 
269 .RE
270 .PP
271
272 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_context (krb5_context context, krb5_context * out)"
273 .PP
274 Make a copy for the Kerberos 5 context, the new krb5_context shoud be freed with \fBkrb5_free_context()\fP.
275 .PP
276 \fBParameters:\fP
277 .RS 4
278 \fIcontext\fP the Kerberos context to copy 
279 .br
280 \fIout\fP the copy of the Kerberos, set to NULL error.
281 .RE
282 .PP
283 \fBReturns:\fP
284 .RS 4
285 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
286 .RE
287 .PP
288
289 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds (krb5_context context, const krb5_creds * incred, krb5_creds ** outcred)"
290 .PP
291 Copy krb5_creds.
292 .PP
293 \fBParameters:\fP
294 .RS 4
295 \fIcontext\fP Kerberos 5 context. 
296 .br
297 \fIincred\fP source credential 
298 .br
299 \fIoutcred\fP destination credential, free with \fBkrb5_free_creds()\fP.
300 .RE
301 .PP
302 \fBReturns:\fP
303 .RS 4
304 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
305 .RE
306 .PP
307
308 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_creds_contents (krb5_context context, const krb5_creds * incred, krb5_creds * c)"
309 .PP
310 Copy content of krb5_creds.
311 .PP
312 \fBParameters:\fP
313 .RS 4
314 \fIcontext\fP Kerberos 5 context. 
315 .br
316 \fIincred\fP source credential 
317 .br
318 \fIc\fP destination credential, free with \fBkrb5_free_cred_contents()\fP.
319 .RE
320 .PP
321 \fBReturns:\fP
322 .RS 4
323 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
324 .RE
325 .PP
326
327 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_data (krb5_context context, const krb5_data * indata, krb5_data ** outdata)"
328 .PP
329 Copy the data into a newly allocated krb5_data.
330 .PP
331 \fBParameters:\fP
332 .RS 4
333 \fIcontext\fP Kerberos 5 context. 
334 .br
335 \fIindata\fP the krb5_data data to copy 
336 .br
337 \fIoutdata\fP new krb5_date to copy too. Free with \fBkrb5_free_data()\fP.
338 .RE
339 .PP
340 \fBReturns:\fP
341 .RS 4
342 Returns 0 to indicate success. Otherwise an kerberos et error code is returned. 
343 .RE
344 .PP
345
346 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_host_realm (krb5_context context, const krb5_realm * from, krb5_realm ** to)"
347 .PP
348 Copy the list of realms from `from' to `to'.
349 .PP
350 \fBParameters:\fP
351 .RS 4
352 \fIcontext\fP Kerberos 5 context. 
353 .br
354 \fIfrom\fP list of realms to copy from. 
355 .br
356 \fIto\fP list of realms to copy to, free list of \fBkrb5_free_host_realm()\fP.
357 .RE
358 .PP
359 \fBReturns:\fP
360 .RS 4
361 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
362 .RE
363 .PP
364
365 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_ticket (krb5_context context, const krb5_ticket * from, krb5_ticket ** to)"
366 .PP
367 Copy ticket and content
368 .PP
369 \fBParameters:\fP
370 .RS 4
371 \fIcontext\fP a Kerberos 5 context 
372 .br
373 \fIfrom\fP ticket to copy 
374 .br
375 \fIto\fP new copy of ticket, free with \fBkrb5_free_ticket()\fP
376 .RE
377 .PP
378 \fBReturns:\fP
379 .RS 4
380 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
381 .RE
382 .PP
383
384 .SS "KRB5_LIB_FUNCTION unsigned long KRB5_LIB_CALL krb5_creds_get_ticket_flags (krb5_creds * creds)"
385 .PP
386 Returns the ticket flags for the credentials in creds. See also \fBkrb5_ticket_get_flags()\fP.
387 .PP
388 \fBParameters:\fP
389 .RS 4
390 \fIcreds\fP credential to get ticket flags from
391 .RE
392 .PP
393 \fBReturns:\fP
394 .RS 4
395 ticket flags 
396 .RE
397 .PP
398
399 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_alloc (krb5_data * p, int len)"
400 .PP
401 Allocate data of and krb5_data.
402 .PP
403 \fBParameters:\fP
404 .RS 4
405 \fIp\fP krb5_data to allocate. 
406 .br
407 \fIlen\fP size to allocate.
408 .RE
409 .PP
410 \fBReturns:\fP
411 .RS 4
412 Returns 0 to indicate success. Otherwise an kerberos et error code is returned. 
413 .RE
414 .PP
415
416 .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_cmp (const krb5_data * data1, const krb5_data * data2)"
417 .PP
418 Compare to data.
419 .PP
420 \fBParameters:\fP
421 .RS 4
422 \fIdata1\fP krb5_data to compare 
423 .br
424 \fIdata2\fP krb5_data to compare
425 .RE
426 .PP
427 \fBReturns:\fP
428 .RS 4
429 return the same way as memcmp(), useful when sorting. 
430 .RE
431 .PP
432
433 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_copy (krb5_data * p, const void * data, size_t len)"
434 .PP
435 Copy the data of len into the krb5_data.
436 .PP
437 \fBParameters:\fP
438 .RS 4
439 \fIp\fP krb5_data to copy into. 
440 .br
441 \fIdata\fP data to copy.. 
442 .br
443 \fIlen\fP new size.
444 .RE
445 .PP
446 \fBReturns:\fP
447 .RS 4
448 Returns 0 to indicate success. Otherwise an kerberos et error code is returned. 
449 .RE
450 .PP
451
452 .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_data_ct_cmp (const krb5_data * data1, const krb5_data * data2)"
453 .PP
454 Compare to data not exposing timing information from the checksum data
455 .PP
456 \fBParameters:\fP
457 .RS 4
458 \fIdata1\fP krb5_data to compare 
459 .br
460 \fIdata2\fP krb5_data to compare
461 .RE
462 .PP
463 \fBReturns:\fP
464 .RS 4
465 returns zero for same data, otherwise non zero. 
466 .RE
467 .PP
468
469 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_free (krb5_data * p)"
470 .PP
471 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.
472 .PP
473 \fBParameters:\fP
474 .RS 4
475 \fIp\fP krb5_data to free. 
476 .RE
477 .PP
478
479 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_data_realloc (krb5_data * p, int len)"
480 .PP
481 Grow (or shrink) the content of krb5_data to a new size.
482 .PP
483 \fBParameters:\fP
484 .RS 4
485 \fIp\fP krb5_data to free. 
486 .br
487 \fIlen\fP new size.
488 .RE
489 .PP
490 \fBReturns:\fP
491 .RS 4
492 Returns 0 to indicate success. Otherwise an kerberos et error code is returned. 
493 .RE
494 .PP
495
496 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_data_zero (krb5_data * p)"
497 .PP
498 Reset the (potentially uninitalized) krb5_data structure.
499 .PP
500 \fBParameters:\fP
501 .RS 4
502 \fIp\fP krb5_data to reset. 
503 .RE
504 .PP
505
506 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_config_files (char ** filenames)"
507 .PP
508 Free a list of configuration files.
509 .PP
510 \fBParameters:\fP
511 .RS 4
512 \fIfilenames\fP list, terminated with a NULL pointer, to be freed. NULL is an valid argument.
513 .RE
514 .PP
515 \fBReturns:\fP
516 .RS 4
517 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
518 .RE
519 .PP
520
521 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_context (krb5_context context)"
522 .PP
523 Frees the krb5_context allocated by \fBkrb5_init_context()\fP.
524 .PP
525 \fBParameters:\fP
526 .RS 4
527 \fIcontext\fP context to be freed. 
528 .RE
529 .PP
530
531 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_cred_contents (krb5_context context, krb5_creds * c)"
532 .PP
533 Free content of krb5_creds.
534 .PP
535 \fBParameters:\fP
536 .RS 4
537 \fIcontext\fP Kerberos 5 context. 
538 .br
539 \fIc\fP krb5_creds to free.
540 .RE
541 .PP
542 \fBReturns:\fP
543 .RS 4
544 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
545 .RE
546 .PP
547
548 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_creds (krb5_context context, krb5_creds * c)"
549 .PP
550 Free krb5_creds.
551 .PP
552 \fBParameters:\fP
553 .RS 4
554 \fIcontext\fP Kerberos 5 context. 
555 .br
556 \fIc\fP krb5_creds to free.
557 .RE
558 .PP
559 \fBReturns:\fP
560 .RS 4
561 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
562 .RE
563 .PP
564
565 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_data (krb5_context context, krb5_data * p)"
566 .PP
567 Free krb5_data (and its content).
568 .PP
569 \fBParameters:\fP
570 .RS 4
571 \fIcontext\fP Kerberos 5 context. 
572 .br
573 \fIp\fP krb5_data to free. 
574 .RE
575 .PP
576
577 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_ticket (krb5_context context, krb5_ticket * ticket)"
578 .PP
579 Free ticket and content
580 .PP
581 \fBParameters:\fP
582 .RS 4
583 \fIcontext\fP a Kerberos 5 context 
584 .br
585 \fIticket\fP ticket to free
586 .RE
587 .PP
588 \fBReturns:\fP
589 .RS 4
590 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
591 .RE
592 .PP
593
594 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_default_config_files (char *** pfilenames)"
595 .PP
596 Get the global configuration list.
597 .PP
598 \fBParameters:\fP
599 .RS 4
600 \fIpfilenames\fP return array of filenames, should be freed with \fBkrb5_free_config_files()\fP.
601 .RE
602 .PP
603 \fBReturns:\fP
604 .RS 4
605 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
606 .RE
607 .PP
608
609 .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)"
610 .PP
611 Get the default encryption types that will be use in communcation with the KDC, clients and servers.
612 .PP
613 \fBParameters:\fP
614 .RS 4
615 \fIcontext\fP Kerberos 5 context. 
616 .br
617 \fIetypes\fP Encryption types, array terminated with ETYPE_NULL(0), caller should free array with krb5_xfree():
618 .RE
619 .PP
620 \fBReturns:\fP
621 .RS 4
622 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
623 .RE
624 .PP
625
626 .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_dns_canonicalize_hostname (krb5_context context)"
627 .PP
628 Get if the library uses DNS to canonicalize hostnames.
629 .PP
630 \fBParameters:\fP
631 .RS 4
632 \fIcontext\fP Kerberos 5 context.
633 .RE
634 .PP
635 \fBReturns:\fP
636 .RS 4
637 return non zero if the library uses DNS to canonicalize hostnames. 
638 .RE
639 .PP
640
641 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_extra_addresses (krb5_context context, krb5_addresses * addresses)"
642 .PP
643 Get extra address to the address list that the library will add to the client's address list when communicating with the KDC.
644 .PP
645 \fBParameters:\fP
646 .RS 4
647 \fIcontext\fP Kerberos 5 context. 
648 .br
649 \fIaddresses\fP addreses to set
650 .RE
651 .PP
652 \fBReturns:\fP
653 .RS 4
654 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
655 .RE
656 .PP
657
658 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_fcache_version (krb5_context context, int * version)"
659 .PP
660 Get version of fcache that the library should use.
661 .PP
662 \fBParameters:\fP
663 .RS 4
664 \fIcontext\fP Kerberos 5 context. 
665 .br
666 \fIversion\fP version number.
667 .RE
668 .PP
669 \fBReturns:\fP
670 .RS 4
671 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
672 .RE
673 .PP
674
675 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_ignore_addresses (krb5_context context, krb5_addresses * addresses)"
676 .PP
677 Get extra addresses to ignore when fetching addresses from the underlaying operating system.
678 .PP
679 \fBParameters:\fP
680 .RS 4
681 \fIcontext\fP Kerberos 5 context. 
682 .br
683 \fIaddresses\fP list addreses ignored
684 .RE
685 .PP
686 \fBReturns:\fP
687 .RS 4
688 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
689 .RE
690 .PP
691
692 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_kdc_sec_offset (krb5_context context, int32_t * sec, int32_t * usec)"
693 .PP
694 Get current offset in time to the KDC.
695 .PP
696 \fBParameters:\fP
697 .RS 4
698 \fIcontext\fP Kerberos 5 context. 
699 .br
700 \fIsec\fP seconds part of offset. 
701 .br
702 \fIusec\fP micro seconds part of offset.
703 .RE
704 .PP
705 \fBReturns:\fP
706 .RS 4
707 returns zero 
708 .RE
709 .PP
710
711 .SS "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_get_max_time_skew (krb5_context context)"
712 .PP
713 Get max time skew allowed.
714 .PP
715 \fBParameters:\fP
716 .RS 4
717 \fIcontext\fP Kerberos 5 context.
718 .RE
719 .PP
720 \fBReturns:\fP
721 .RS 4
722 timeskew in seconds. 
723 .RE
724 .PP
725
726 .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_get_use_admin_kdc (krb5_context context)"
727 .PP
728 Make the kerberos library default to the admin KDC.
729 .PP
730 \fBParameters:\fP
731 .RS 4
732 \fIcontext\fP Kerberos 5 context.
733 .RE
734 .PP
735 \fBReturns:\fP
736 .RS 4
737 boolean flag to telling the context will use admin KDC as the default KDC. 
738 .RE
739 .PP
740
741 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_context (krb5_context * context)"
742 .PP
743 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.
744 .PP
745 \fBParameters:\fP
746 .RS 4
747 \fIcontext\fP pointer to returned context
748 .RE
749 .PP
750 \fBReturns:\fP
751 .RS 4
752 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. 
753 .RE
754 .PP
755
756 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_ets (krb5_context context)"
757 .PP
758 Init the built-in ets in the Kerberos library.
759 .PP
760 \fBParameters:\fP
761 .RS 4
762 \fIcontext\fP kerberos context to add the ets too 
763 .RE
764 .PP
765
766 .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_is_thread_safe (void)"
767 .PP
768 Runtime check if the Kerberos library was complied with thread support.
769 .PP
770 \fBReturns:\fP
771 .RS 4
772 TRUE if the library was compiled with thread support, FALSE if not. 
773 .RE
774 .PP
775
776 .SS "KRB5_LIB_FUNCTION const krb5_enctype* KRB5_LIB_CALL krb5_kerberos_enctypes (krb5_context context)"
777 .PP
778 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.
779 .PP
780 \fBReturns:\fP
781 .RS 4
782 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. 
783 .RE
784 .PP
785
786 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_krbhst_get_addrinfo (krb5_context context, krb5_krbhst_info * host, struct addrinfo ** ai)"
787 .PP
788 Return an `struct addrinfo *' for a KDC host.
789 .PP
790 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. 
791 .PP
792 First try this as an IP address, this allows us to add a dot at the end to stop using the search domains.
793 .PP
794 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. 
795 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_prepend_config_files_default (const char * filelist, char *** pfilenames)"
796 .PP
797 Prepend the filename to the global configuration list.
798 .PP
799 \fBParameters:\fP
800 .RS 4
801 \fIfilelist\fP a filename to add to the default list of filename 
802 .br
803 \fIpfilenames\fP return array of filenames, should be freed with \fBkrb5_free_config_files()\fP.
804 .RE
805 .PP
806 \fBReturns:\fP
807 .RS 4
808 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
809 .RE
810 .PP
811
812 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_config_files (krb5_context context, char ** filenames)"
813 .PP
814 Reinit the context from a new set of filenames.
815 .PP
816 \fBParameters:\fP
817 .RS 4
818 \fIcontext\fP context to add configuration too. 
819 .br
820 \fIfilenames\fP array of filenames, end of list is indicated with a NULL filename.
821 .RE
822 .PP
823 \fBReturns:\fP
824 .RS 4
825 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
826 .RE
827 .PP
828
829 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_default_in_tkt_etypes (krb5_context context, const krb5_enctype * etypes)"
830 .PP
831 Set the default encryption types that will be use in communcation with the KDC, clients and servers.
832 .PP
833 \fBParameters:\fP
834 .RS 4
835 \fIcontext\fP Kerberos 5 context. 
836 .br
837 \fIetypes\fP Encryption types, array terminated with ETYPE_NULL (0).
838 .RE
839 .PP
840 \fBReturns:\fP
841 .RS 4
842 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
843 .RE
844 .PP
845
846 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_dns_canonicalize_hostname (krb5_context context, krb5_boolean flag)"
847 .PP
848 Set if the library should use DNS to canonicalize hostnames.
849 .PP
850 \fBParameters:\fP
851 .RS 4
852 \fIcontext\fP Kerberos 5 context. 
853 .br
854 \fIflag\fP if its dns canonicalizion is used or not. 
855 .RE
856 .PP
857
858 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_extra_addresses (krb5_context context, const krb5_addresses * addresses)"
859 .PP
860 Set extra address to the address list that the library will add to the client's address list when communicating with the KDC.
861 .PP
862 \fBParameters:\fP
863 .RS 4
864 \fIcontext\fP Kerberos 5 context. 
865 .br
866 \fIaddresses\fP addreses to set
867 .RE
868 .PP
869 \fBReturns:\fP
870 .RS 4
871 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
872 .RE
873 .PP
874
875 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_fcache_version (krb5_context context, int version)"
876 .PP
877 Set version of fcache that the library should use.
878 .PP
879 \fBParameters:\fP
880 .RS 4
881 \fIcontext\fP Kerberos 5 context. 
882 .br
883 \fIversion\fP version number.
884 .RE
885 .PP
886 \fBReturns:\fP
887 .RS 4
888 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
889 .RE
890 .PP
891
892 .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_set_home_dir_access (krb5_context context, krb5_boolean allow)"
893 .PP
894 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.
895 .PP
896 For home directory access to be allowed, both the global state and the krb5_context state have to be allowed.
897 .PP
898 Administrator (root user), never uses the home directory.
899 .PP
900 \fBParameters:\fP
901 .RS 4
902 \fIcontext\fP a Kerberos 5 context or NULL 
903 .br
904 \fIallow\fP allow if TRUE home directory 
905 .RE
906 .PP
907 \fBReturns:\fP
908 .RS 4
909 the old value 
910 .RE
911 .PP
912
913 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_ignore_addresses (krb5_context context, const krb5_addresses * addresses)"
914 .PP
915 Set extra addresses to ignore when fetching addresses from the underlaying operating system.
916 .PP
917 \fBParameters:\fP
918 .RS 4
919 \fIcontext\fP Kerberos 5 context. 
920 .br
921 \fIaddresses\fP addreses to ignore
922 .RE
923 .PP
924 \fBReturns:\fP
925 .RS 4
926 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
927 .RE
928 .PP
929
930 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_kdc_sec_offset (krb5_context context, int32_t sec, int32_t usec)"
931 .PP
932 Set current offset in time to the KDC.
933 .PP
934 \fBParameters:\fP
935 .RS 4
936 \fIcontext\fP Kerberos 5 context. 
937 .br
938 \fIsec\fP seconds part of offset. 
939 .br
940 \fIusec\fP micro seconds part of offset.
941 .RE
942 .PP
943 \fBReturns:\fP
944 .RS 4
945 returns zero 
946 .RE
947 .PP
948
949 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_max_time_skew (krb5_context context, time_t t)"
950 .PP
951 Set max time skew allowed.
952 .PP
953 \fBParameters:\fP
954 .RS 4
955 \fIcontext\fP Kerberos 5 context. 
956 .br
957 \fIt\fP timeskew in seconds. 
958 .RE
959 .PP
960
961 .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)"
962 .PP
963 Change password using creds.
964 .PP
965 \fBParameters:\fP
966 .RS 4
967 \fIcontext\fP a Keberos context 
968 .br
969 \fIcreds\fP The initial kadmin/passwd for the principal or an admin principal 
970 .br
971 \fInewpw\fP The new password to set 
972 .br
973 \fItargprinc\fP if unset, the default principal is used. 
974 .br
975 \fIresult_code\fP Result code, KRB5_KPASSWD_SUCCESS is when password is changed. 
976 .br
977 \fIresult_code_string\fP binary message from the server, contains at least the result_code. 
978 .br
979 \fIresult_string\fP A message from the kpasswd service or the library in human printable form. The string is NUL terminated.
980 .RE
981 .PP
982 \fBReturns:\fP
983 .RS 4
984 On sucess and *result_code is KRB5_KPASSWD_SUCCESS, the password is changed.
985 .RE
986 .PP
987
988 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_real_time (krb5_context context, krb5_timestamp sec, int32_t usec)"
989 .PP
990 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.
991 .PP
992 \fBParameters:\fP
993 .RS 4
994 \fIcontext\fP Keberos 5 context. 
995 .br
996 \fIsec\fP The applications new of 'now' in seconds 
997 .br
998 \fIusec\fP The applications new of 'now' in micro seconds
999 .RE
1000 .PP
1001 \fBReturns:\fP
1002 .RS 4
1003 Kerberos 5 error code, see krb5_get_error_message(). 
1004 .RE
1005 .PP
1006
1007 .PP
1008 If the caller passes in a negative usec, its assumed to be unknown and the function will use the current time usec. 
1009 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_use_admin_kdc (krb5_context context, krb5_boolean flag)"
1010 .PP
1011 Make the kerberos library default to the admin KDC.
1012 .PP
1013 \fBParameters:\fP
1014 .RS 4
1015 \fIcontext\fP Kerberos 5 context. 
1016 .br
1017 \fIflag\fP boolean flag to select if the use the admin KDC or not. 
1018 .RE
1019 .PP
1020
1021 .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)"
1022 .PP
1023 Extract the authorization data type of type from the ticket. Store the field in data. This function is to use for kerberos applications.
1024 .PP
1025 \fBParameters:\fP
1026 .RS 4
1027 \fIcontext\fP a Kerberos 5 context 
1028 .br
1029 \fIticket\fP Kerberos ticket 
1030 .br
1031 \fItype\fP type to fetch 
1032 .br
1033 \fIdata\fP returned data, free with \fBkrb5_data_free()\fP 
1034 .RE
1035 .PP
1036
1037 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_client (krb5_context context, const krb5_ticket * ticket, krb5_principal * client)"
1038 .PP
1039 Return client principal in ticket
1040 .PP
1041 \fBParameters:\fP
1042 .RS 4
1043 \fIcontext\fP a Kerberos 5 context 
1044 .br
1045 \fIticket\fP ticket to copy 
1046 .br
1047 \fIclient\fP client principal, free with \fBkrb5_free_principal()\fP
1048 .RE
1049 .PP
1050 \fBReturns:\fP
1051 .RS 4
1052 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
1053 .RE
1054 .PP
1055
1056 .SS "KRB5_LIB_FUNCTION time_t KRB5_LIB_CALL krb5_ticket_get_endtime (krb5_context context, const krb5_ticket * ticket)"
1057 .PP
1058 Return end time of ticket
1059 .PP
1060 \fBParameters:\fP
1061 .RS 4
1062 \fIcontext\fP a Kerberos 5 context 
1063 .br
1064 \fIticket\fP ticket to copy
1065 .RE
1066 .PP
1067 \fBReturns:\fP
1068 .RS 4
1069 end time of ticket 
1070 .RE
1071 .PP
1072
1073 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ticket_get_server (krb5_context context, const krb5_ticket * ticket, krb5_principal * server)"
1074 .PP
1075 Return server principal in ticket
1076 .PP
1077 \fBParameters:\fP
1078 .RS 4
1079 \fIcontext\fP a Kerberos 5 context 
1080 .br
1081 \fIticket\fP ticket to copy 
1082 .br
1083 \fIserver\fP server principal, free with \fBkrb5_free_principal()\fP
1084 .RE
1085 .PP
1086 \fBReturns:\fP
1087 .RS 4
1088 Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). 
1089 .RE
1090 .PP
1091