crypto/dist/heimdal/lib/krb5/krb5_get_krbhst.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_krbhst.3 14905 2005-04-24 07:46:59Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd April 24, 2005
  36 .Dt KRB5_GET_KRBHST 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_get_krbhst ,
  40 .Nm krb5_get_krb_admin_hst ,
  41 .Nm krb5_get_krb_changepw_hst ,
  42 .Nm krb5_get_krb524hst ,
  43 .Nm krb5_free_krbhst
  44 .Nd lookup Kerberos KDC hosts
  45 .Sh LIBRARY
  46 Kerberos 5 Library (libkrb5, -lkrb5)
  47 .Sh SYNOPSIS
  48 .In krb5/krb5.h
  49 .Ft krb5_error_code
  50 .Fn krb5_get_krbhst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
  51 .Ft krb5_error_code
  52 .Fn krb5_get_krb_admin_hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
  53 .Ft krb5_error_code
  54 .Fn krb5_get_krb_changepw_hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
  55 .Ft krb5_error_code
  56 .Fn krb5_get_krb524hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
  57 .Ft krb5_error_code
  58 .Fn krb5_free_krbhst "krb5_context context" "char **hostlist"
  59 .Sh DESCRIPTION
  60 These functions implement the old API to get a list of Kerberos hosts,
  61 and are thus similar to the
  62 .Fn krb5_krbhst_init
  63 functions. However, since these functions returns
  64 .Em all
  65 hosts in one go, they potentially have to do more lookups than
  66 necessary. These functions remain for compatibility reasons.
  67 .Pp
  68 After a call to one of these functions,
  69 .Fa hostlist
  70 is a
  71 .Dv NULL
  72 terminated list of strings, pointing to the requested Kerberos hosts. These should be freed with
  73 .Fn krb5_free_krbhst
  74 when done with.
  75 .Sh EXAMPLES
  76 The following code will print the KDCs of the realm
  77 .Dq MY.REALM .
  78 .Bd -literal -offset indent
  79 char **hosts, **p;
  80 krb5_get_krbhst(context, "MY.REALM", &hosts);
  81 for(p = hosts; *p; p++)
  82     printf("%s\\n", *p);
  83 krb5_free_krbhst(context, hosts);
  84 .Ed
  85 .\" .Sh BUGS
  86 .Sh SEE ALSO
  87 .Xr krb5_krbhst_init 3