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