1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
.\" $NetBSD: krb5_error.3,v 1.3 2023/06/19 21:41:40 christos Exp $
.\"
.TH "krb5_error" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal Kerberos 5 library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
krb5_error \- Heimdal Kerberos 5 error reporting functions
.SH SYNOPSIS
.br
.PP
.SS "Functions"
.in +1c
.ti -1c
.RI "KRB5_LIB_FUNCTION char *KRB5_LIB_CALL \fBkrb5_get_error_string\fP (krb5_context context) KRB5_DEPRECATED_FUNCTION('Use \fBkrb5_get_error_message\fP instead')"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_eai_to_heim_errno\fP (int eai_errno, int system_error)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_h_errno_to_heim_errno\fP (int eai_errno)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_clear_error_message\fP (krb5_context context)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_set_error_message\fP (krb5_context context, krb5_error_code ret, const char *fmt,\&.\&.\&.) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_vset_error_message\fP (krb5_context context, krb5_error_code ret, const char *fmt, va_list args) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_prepend_error_message\fP (krb5_context context, krb5_error_code ret, const char *fmt,\&.\&.\&.) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_vprepend_error_message\fP (krb5_context context, krb5_error_code ret, const char *fmt, va_list args) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL \fBkrb5_get_error_message\fP (krb5_context context, krb5_error_code code)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_free_error_message\fP (krb5_context context, const char *msg)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_vwarn\fP (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_warn\fP (krb5_context context, krb5_error_code code, const char *fmt,\&.\&.\&.) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_vwarnx\fP (krb5_context context, const char *fmt, va_list ap) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_warnx\fP (krb5_context context, const char *fmt,\&.\&.\&.) __attribute__((__format__(__printf__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_verr\fP (krb5_context context, int eval, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_err\fP (krb5_context context, int eval, krb5_error_code code, const char *fmt,\&.\&.\&.) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_verrx\fP (krb5_context context, int eval, const char *fmt, va_list ap) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_errx\fP (krb5_context context, int eval, const char *fmt,\&.\&.\&.) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_vabort\fP (krb5_context context, krb5_error_code code, const char *fmt, va_list ap) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_abort\fP (krb5_context context, krb5_error_code code, const char *fmt,\&.\&.\&.) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_abortx\fP (krb5_context context, const char *fmt,\&.\&.\&.) __attribute__((__noreturn__"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_set_warn_dest\fP (krb5_context context, krb5_log_facility *fac)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_log_facility *KRB5_LIB_CALL \fBkrb5_get_warn_dest\fP (krb5_context context)"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Function Documentation"
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_abort (krb5_context context, krb5_error_code code, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr, include the error from the last failure and then abort\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.br
\fI\&.\&.\&.\fP arguments for format string
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_abortx (krb5_context context, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr, and then abort\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIfmt\fP printf format string of message to print
.br
\fI\&.\&.\&.\fP arguments for format string
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_clear_error_message (krb5_context context)"
Clears the error message from the Kerberos 5 context\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The Kerberos 5 context to clear
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_eai_to_heim_errno (int eai_errno, int system_error)"
Convert the getaddrinfo() error code to a Kerberos et error code\&.
.PP
\fBParameters\fP
.RS 4
\fIeai_errno\fP contains the error code from getaddrinfo()\&.
.br
\fIsystem_error\fP should have the value of errno after the failed getaddrinfo()\&.
.RE
.PP
\fBReturns\fP
.RS 4
Kerberos error code representing the EAI errors\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_err (krb5_context context, int eval, krb5_error_code code, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr, include bthe error from the last failure and then exit\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIeval\fP the exit code to exit with
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_errx (krb5_context context, int eval, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr, and then exit\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIeval\fP the exit code to exit with
.br
\fIfmt\fP message to print
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_error_message (krb5_context context, const char * msg)"
Free the error message returned by \fBkrb5_get_error_message()\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos context
.br
\fImsg\fP error message to free, returned byg \fBkrb5_get_error_message()\fP\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_get_error_message (krb5_context context, krb5_error_code code)"
Return the error message for `code' in context\&. On memory allocation error the function returns NULL\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.br
\fIcode\fP Error code related to the error
.RE
.PP
\fBReturns\fP
.RS 4
an error string, needs to be freed with \fBkrb5_free_error_message()\fP\&. The functions return NULL on error\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION char* KRB5_LIB_CALL krb5_get_error_string (krb5_context context)"
Return the error message in context\&. On error or no error string, the function returns NULL\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.RE
.PP
\fBReturns\fP
.RS 4
an error string, needs to be freed with \fBkrb5_free_error_message()\fP\&. The functions return NULL on error\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_log_facility* KRB5_LIB_CALL krb5_get_warn_dest (krb5_context context)"
Get the default logging facility\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_errno_to_heim_errno (int eai_errno)"
Convert the gethostname() error code (h_error) to a Kerberos et error code\&.
.PP
\fBParameters\fP
.RS 4
\fIeai_errno\fP contains the error code from gethostname()\&.
.RE
.PP
\fBReturns\fP
.RS 4
Kerberos error code representing the gethostname errors\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_prepend_error_message (krb5_context context, krb5_error_code ret, const char * fmt, \&.\&.\&.)"
Prepend the context full error string for a specific error code\&. The error that is stored should be internationalized\&.
.PP
The if context is NULL, no error string is stored\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.br
\fIret\fP The error code
.br
\fIfmt\fP Error string for the error code
.br
\fI\&.\&.\&.\fP printf(3) style parameters\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_set_error_message (krb5_context context, krb5_error_code ret, const char * fmt, \&.\&.\&.)"
Set the context full error string for a specific error code\&. The error that is stored should be internationalized\&.
.PP
The if context is NULL, no error string is stored\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.br
\fIret\fP The error code
.br
\fIfmt\fP Error string for the error code
.br
\fI\&.\&.\&.\fP printf(3) style parameters\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_set_warn_dest (krb5_context context, krb5_log_facility * fac)"
Set the default logging facility\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIfac\fP Facility to use for logging\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vabort (krb5_context context, krb5_error_code code, const char * fmt, va_list ap)"
Log a warning to the log, default stderr, include bthe error from the last failure and then abort\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.br
\fIap\fP arguments
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_verr (krb5_context context, int eval, krb5_error_code code, const char * fmt, va_list ap)"
Log a warning to the log, default stderr, include bthe error from the last failure and then exit\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIeval\fP the exit code to exit with
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.br
\fIap\fP arguments
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_verrx (krb5_context context, int eval, const char * fmt, va_list ap)"
Log a warning to the log, default stderr, and then exit\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context
.br
\fIeval\fP the exit code to exit with
.br
\fIfmt\fP message to print
.br
\fIap\fP arguments
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_vprepend_error_message (krb5_context context, krb5_error_code ret, const char * fmt, va_list args)"
Prepend the contexts's full error string for a specific error code\&.
.PP
The if context is NULL, no error string is stored\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.br
\fIret\fP The error code
.br
\fIfmt\fP Error string for the error code
.br
\fIargs\fP printf(3) style parameters\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_vset_error_message (krb5_context context, krb5_error_code ret, const char * fmt, va_list args)"
Set the context full error string for a specific error code\&.
.PP
The if context is NULL, no error string is stored\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Kerberos 5 context
.br
\fIret\fP The error code
.br
\fIfmt\fP Error string for the error code
.br
\fIargs\fP printf(3) style parameters\&.
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarn (krb5_context context, krb5_error_code code, const char * fmt, va_list ap)"
Log a warning to the log, default stderr, include the error from the last failure\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.br
\fIap\fP arguments
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_vwarnx (krb5_context context, const char * fmt, va_list ap)"
Log a warning to the log, default stderr\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
\fIfmt\fP message to print
.br
\fIap\fP arguments
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_warn (krb5_context context, krb5_error_code code, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr, include the error from the last failure\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
\fIcode\fP error code of the last error
.br
\fIfmt\fP message to print
.RE
.PP
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_warnx (krb5_context context, const char * fmt, \&.\&.\&.)"
Log a warning to the log, default stderr\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
\fIfmt\fP message to print
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code\&.
|
