1  .\" Copyright (c) 2001 Kungliga Tekniska Högskolan
 2  .\" (Royal Institute of Technology, Stockholm, Sweden).
 3  .\" All rights reserved.
 4  .\"
 5  .\" Redistribution and use in source and binary forms, with or without
 6  .\" modification, are permitted provided that the following conditions
 7  .\" are met:
 8  .\"
 9  .\" 1. Redistributions of source code must retain the above copyright
10  .\"    notice, this list of conditions and the following disclaimer.
11  .\"
12  .\" 2. Redistributions in binary form must reproduce the above copyright
13  .\"    notice, this list of conditions and the following disclaimer in the
14  .\"    documentation and/or other materials provided with the distribution.
15  .\"
16  .\" 3. Neither the name of the Institute nor the names of its contributors
17  .\"    may be used to endorse or promote products derived from this software
18  .\"    without specific prior written permission.
19  .\"
20  .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21  .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24  .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  .\" SUCH DAMAGE.
31  .\"
32  .\" $Id$
33  .\"
34  .Dd July  1, 2001
35  .Dt KRB5_GET_ADDRS 3
36  .Os HEIMDAL
37  .Sh NAME
38  .Nm krb5_get_all_client_addrs ,
39  .Nm krb5_get_all_server_addrs
40  .Nd return local addresses
41  .Sh LIBRARY
42  Kerberos 5 Library (libkrb5, -lkrb5)
43  .Sh SYNOPSIS
44  .In krb5.h
45  .Ft "krb5_error_code"
46  .Fn krb5_get_all_client_addrs "krb5_context context" "krb5_addresses *addrs"
47  .Ft "krb5_error_code"
48  .Fn krb5_get_all_server_addrs "krb5_context context" "krb5_addresses *addrs"
49  .Sh DESCRIPTION
50  These functions return in
51  .Fa addrs
52  a list of addresses associated with the local
53  host.
54  .Pp
55  The server variant returns all configured interface addresses (if
56  possible), including loop-back addresses. This is useful if you want
57  to create sockets to listen to.
58  .Pp
59  The client version will also scan local interfaces (can be turned off
60  by setting
61  .Li libdefaults/scan_interfaces
62  to false in
63  .Pa krb5.conf ) ,
64  but will not include loop-back addresses, unless there are no other
65  addresses found. It will remove all addresses included in
66  .Li libdefaults/ignore_addresses
67  but will unconditionally include addresses in
68  .Li libdefaults/extra_addresses .
69  .Pp
70  The returned addresses should be freed by calling
71  .Fn krb5_free_addresses .
72  .\".Sh EXAMPLE
73  .Sh SEE ALSO
74  .Xr krb5_free_addresses 3