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

   1 .\" Copyright (c) 2001-2005 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_krbhst_init.3 15110 2005-05-10 09:21:06Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd May 10, 2005
  36 .Dt KRB5_KRBHST_INIT 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_krbhst_init ,
  40 .Nm krb5_krbhst_init_flags ,
  41 .Nm krb5_krbhst_next ,
  42 .Nm krb5_krbhst_next_as_string ,
  43 .Nm krb5_krbhst_reset ,
  44 .Nm krb5_krbhst_free ,
  45 .Nm krb5_krbhst_format_string ,
  46 .Nm krb5_krbhst_get_addrinfo
  47 .Nd lookup Kerberos KDC hosts
  48 .Sh LIBRARY
  49 Kerberos 5 Library (libkrb5, -lkrb5)
  50 .Sh SYNOPSIS
  51 .In krb5/krb5.h
  52 .Ft krb5_error_code
  53 .Fn krb5_krbhst_init "krb5_context context" "const char *realm" "unsigned int type" "krb5_krbhst_handle *handle"
  54 .Ft krb5_error_code
  55 .Fn krb5_krbhst_init_flags "krb5_context context" "const char *realm" "unsigned int type" "int flags" "krb5_krbhst_handle *handle"
  56 .Ft krb5_error_code
  57 .Fn "krb5_krbhst_next" "krb5_context context" "krb5_krbhst_handle handle" "krb5_krbhst_info **host"
  58 .Ft krb5_error_code
  59 .Fn krb5_krbhst_next_as_string "krb5_context context" "krb5_krbhst_handle handle" "char *hostname" "size_t hostlen"
  60 .Ft void
  61 .Fn krb5_krbhst_reset "krb5_context context" "krb5_krbhst_handle handle"
  62 .Ft void
  63 .Fn krb5_krbhst_free "krb5_context context" "krb5_krbhst_handle handle"
  64 .Ft krb5_error_code
  65 .Fn krb5_krbhst_format_string "krb5_context context" "const krb5_krbhst_info *host" "char *hostname" "size_t hostlen"
  66 .Ft krb5_error_code
  67 .Fn krb5_krbhst_get_addrinfo "krb5_context context" "krb5_krbhst_info *host" "struct addrinfo **ai"
  68 .Sh DESCRIPTION
  69 These functions are used to sequence through all Kerberos hosts of a
  70 particular realm and service. The service type can be the KDCs, the
  71 administrative servers, the password changing servers, or the servers
  72 for Kerberos 4 ticket conversion.
  73 .Pp
  74 First a handle to a particular service is obtained by calling
  75 .Fn krb5_krbhst_init
  76 (or
  77 .Fn krb5_krbhst_init_flags )
  78 with the
  79 .Fa realm
  80 of interest and the type of service to lookup. The
  81 .Fa type
  82 can be one of:
  83 .Pp
  84 .Bl -tag -width Ds -compact -offset indent
  85 .It KRB5_KRBHST_KDC
  86 .It KRB5_KRBHST_ADMIN
  87 .It KRB5_KRBHST_CHANGEPW
  88 .It KRB5_KRBHST_KRB524
  89 .El
  90 .Pp
  91 The
  92 .Fa handle
  93 is returned to the caller, and should be passed to the other
  94 functions.
  95 .Pp
  96 The
  97 .Fa flag
  98 argument to
  99 .Nm krb5_krbhst_init_flags
 100 is the same flags as
 101 .Fn krb5_send_to_kdc_flags
 102 uses.
 103 Possible values are:
 104 .Pp
 105 .Bl -tag -width KRB5_KRBHST_FLAGS_LARGE_MSG -compact -offset indent
 106 .It KRB5_KRBHST_FLAGS_MASTER
 107 only talk to master (readwrite) KDC
 108 .It KRB5_KRBHST_FLAGS_LARGE_MSG
 109 this is a large message, so use transport that can handle that.
 110 .El
 111 .Pp
 112 For each call to
 113 .Fn krb5_krbhst_next
 114 information on a new host is returned. The former function returns in
 115 .Fa host
 116 a pointer to a structure containing information about the host, such
 117 as protocol, hostname, and port:
 118 .Bd -literal -offset indent
 119 typedef struct krb5_krbhst_info {
 120     enum { KRB5_KRBHST_UDP,
 121            KRB5_KRBHST_TCP,
 122            KRB5_KRBHST_HTTP } proto;
 123     unsigned short port;
 124     struct addrinfo *ai;
 125     struct krb5_krbhst_info *next;
 126     char hostname[1];
 127 } krb5_krbhst_info;
 128 .Ed
 129 .Pp
 130 The related function,
 131 .Fn krb5_krbhst_next_as_string ,
 132 return the same information as a URL-like string.
 133 .Pp
 134 When there are no more hosts, these functions return
 135 .Dv KRB5_KDC_UNREACH .
 136 .Pp
 137 To re-iterate over all hosts, call
 138 .Fn krb5_krbhst_reset
 139 and the next call to
 140 .Fn krb5_krbhst_next
 141 will return the first host.
 142 .Pp
 143 When done with the handle,
 144 .Fn krb5_krbhst_free
 145 should be called.
 146 .Pp
 147 To use a
 148 .Va krb5_krbhst_info ,
 149 there are two functions:
 150 .Fn krb5_krbhst_format_string
 151 that will return a printable representation of that struct
 152 and
 153 .Fn krb5_krbhst_get_addrinfo
 154 that will return a
 155 .Va struct addrinfo
 156 that can then be used for communicating with the server mentioned.
 157 .Sh EXAMPLES
 158 The following code will print the KDCs of the realm
 159 .Dq MY.REALM :
 160 .Bd -literal -offset indent
 161 krb5_krbhst_handle handle;
 162 char host[MAXHOSTNAMELEN];
 163 krb5_krbhst_init(context, "MY.REALM", KRB5_KRBHST_KDC, &handle);
 164 while(krb5_krbhst_next_as_string(context, handle,
 165                                  host, sizeof(host)) == 0)
 166     printf("%s\\n", host);
 167 krb5_krbhst_free(context, handle);
 168 .Ed
 169 .\" .Sh BUGS
 170 .Sh SEE ALSO
 171 .Xr getaddrinfo 3 ,
 172 .Xr krb5_get_krbhst 3 ,
 173 .Xr krb5_send_to_kdc_flags 3
 174 .Sh HISTORY
 175 These functions first appeared in Heimdal 0.3g.