1.\" $Id: krb5_get_all_client_addrs.3,v 1.4 2002/08/28 15:30:52 joda Exp $
| 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: krb5_get_all_client_addrs.3,v 1.6 2003/04/16 13:58:16 lha Exp $
33.\"
|
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
| 34.Dd July 1, 2001
35.Dt KRB5_GET_ADDRS 3
36.Sh NAME
37.Nm krb5_get_all_client_addrs ,
38.Nm krb5_get_all_server_addrs
39.Nd return local addresses
40.Sh LIBRARY
41Kerberos 5 Library (libkrb5, -lkrb5)
42.Sh SYNOPSIS
|
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
| 44.Ft "krb5_error_code"
45.Fn krb5_get_all_client_addrs "krb5_context context" "krb5_addresses *addrs"
46.Ft "krb5_error_code"
47.Fn krb5_get_all_server_addrs "krb5_context context" "krb5_addresses *addrs"
48.Sh DESCRIPTION
49These functions return in
50.Fa addrs
51a list of addresses associated with the local
52host.
53.Pp
54The server variant returns all configured interface addresses (if
55possible), including loop-back addresses. This is useful if you want
56to create sockets to listen to.
57.Pp
58The client version will also scan local interfaces (can be turned off
59by setting
60.Li libdefaults/scan_interfaces
61to false in
62.Pa krb5.conf ) ,
63but will not include loop-back addresses, unless there are no other
64addresses found. It will remove all addresses included in
65.Li libdefaults/ignore_addresses
66but will unconditionally include addresses in
67.Li libdefaults/extra_addresses .
68.Pp
69The returned addresses should be freed by calling
70.Fn krb5_free_addresses .
71.\".Sh EXAMPLE
72.Sh SEE ALSO
73.Xr krb5_free_addresses 3
|