xref: /freebsd/crypto/heimdal/lib/krb5/krb5_get_all_client_addrs.3 (revision 11f0b352e05306cf6f1f85e9087022c0a92624a3)
1.\" $Id: krb5_get_all_client_addrs.3,v 1.2 2001/11/09 09:33:52 joda Exp $
2.Dd July  1, 2001
3.Dt KRB5_GET_ADDRS 3
4.Sh NAME
5.Nm krb5_get_all_client_addrs ,
6.Nm krb5_get_all_server_addrs
7.Nd return local addresses
8.Sh SYNOPSIS
9.Fd #include <krb5.h>
10.Ft "krb5_error_code"
11.Fn krb5_get_all_client_addrs "krb5_context context" "krb5_addresses *addrs"
12.Ft "krb5_error_code"
13.Fn krb5_get_all_server_addrs "krb5_context context" "krb5_addresses *addrs"
14.Sh DESCRIPTION
15These functions return in
16.Fa addrs
17a list of addresses associated with the local
18host.
19.Pp
20The server variant returns all configured interface addresses (if
21possible), including loop-back addresses. This is useful if you want
22to create sockets to listen to.
23.Pp
24The client version will also scan local interfaces (can be turned off
25by setting
26.Li libdefaults/scan_interfaces
27to false in
28.Pa krb5.conf ) ,
29but will not include loop-back addresses, unless there are no other
30addresses found. It will remove all addresses included in
31.Li libdefaults/ignore_addresses
32but will unconditionally include addresses in
33.Li libdefaults/extra_addresses .
34.Pp
35The returned addresses should be freed by calling
36.Fn krb5_free_addresses .
37.\".Sh EXAMPLE
38.Sh SEE ALSO
39.Xr krb5_free_addresses 3
40