crypto/dist/heimdal/lib/krb5/krb5_get_all_client_addrs.3

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