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