1.\" $Id: krb5_get_all_client_addrs.3,v 1.4 2002/08/28 15:30: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 LIBRARY
9Kerberos 5 Library (libkrb5, -lkrb5)
10.Sh SYNOPSIS
11.Fd #include <krb5.h>
12.Ft "krb5_error_code"
13.Fn krb5_get_all_client_addrs "krb5_context context" "krb5_addresses *addrs"
14.Ft "krb5_error_code"
15.Fn krb5_get_all_server_addrs "krb5_context context" "krb5_addresses *addrs"
16.Sh DESCRIPTION
17These functions return in
18.Fa addrs
19a list of addresses associated with the local
20host.
21.Pp
22The server variant returns all configured interface addresses (if
23possible), including loop-back addresses. This is useful if you want
24to create sockets to listen to.
25.Pp
26The client version will also scan local interfaces (can be turned off
27by setting
28.Li libdefaults/scan_interfaces
29to false in
30.Pa krb5.conf ) ,
31but will not include loop-back addresses, unless there are no other
32addresses found. It will remove all addresses included in
33.Li libdefaults/ignore_addresses
34but will unconditionally include addresses in
35.Li libdefaults/extra_addresses .
36.Pp
37The returned addresses should be freed by calling
38.Fn krb5_free_addresses .
39.\".Sh EXAMPLE
40.Sh SEE ALSO
41.Xr krb5_free_addresses 3