xref: /minix3/crypto/external/bsd/heimdal/dist/lib/krb5/krb5_get_krbhst.3 (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc.\"	$NetBSD: krb5_get_krbhst.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $
2*ebfedea0SLionel Sambuc.\"
3*ebfedea0SLionel Sambuc.\" Copyright (c) 2001 Kungliga Tekniska Högskolan
4*ebfedea0SLionel Sambuc.\" (Royal Institute of Technology, Stockholm, Sweden).
5*ebfedea0SLionel Sambuc.\" All rights reserved.
6*ebfedea0SLionel Sambuc.\"
7*ebfedea0SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
8*ebfedea0SLionel Sambuc.\" modification, are permitted provided that the following conditions
9*ebfedea0SLionel Sambuc.\" are met:
10*ebfedea0SLionel Sambuc.\"
11*ebfedea0SLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
12*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
13*ebfedea0SLionel Sambuc.\"
14*ebfedea0SLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
15*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
16*ebfedea0SLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
17*ebfedea0SLionel Sambuc.\"
18*ebfedea0SLionel Sambuc.\" 3. Neither the name of the Institute nor the names of its contributors
19*ebfedea0SLionel Sambuc.\"    may be used to endorse or promote products derived from this software
20*ebfedea0SLionel Sambuc.\"    without specific prior written permission.
21*ebfedea0SLionel Sambuc.\"
22*ebfedea0SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23*ebfedea0SLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*ebfedea0SLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*ebfedea0SLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26*ebfedea0SLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*ebfedea0SLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*ebfedea0SLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*ebfedea0SLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*ebfedea0SLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*ebfedea0SLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*ebfedea0SLionel Sambuc.\" SUCH DAMAGE.
33*ebfedea0SLionel Sambuc.\"
34*ebfedea0SLionel Sambuc.\" Id
35*ebfedea0SLionel Sambuc.\"
36*ebfedea0SLionel Sambuc.Dd April 24, 2005
37*ebfedea0SLionel Sambuc.Dt KRB5_GET_KRBHST 3
38*ebfedea0SLionel Sambuc.Os
39*ebfedea0SLionel Sambuc.Sh NAME
40*ebfedea0SLionel Sambuc.Nm krb5_get_krbhst ,
41*ebfedea0SLionel Sambuc.Nm krb5_get_krb_admin_hst ,
42*ebfedea0SLionel Sambuc.Nm krb5_get_krb_changepw_hst ,
43*ebfedea0SLionel Sambuc.Nm krb5_get_krb524hst ,
44*ebfedea0SLionel Sambuc.Nm krb5_free_krbhst
45*ebfedea0SLionel Sambuc.Nd lookup Kerberos KDC hosts
46*ebfedea0SLionel Sambuc.Sh LIBRARY
47*ebfedea0SLionel SambucKerberos 5 Library (libkrb5, -lkrb5)
48*ebfedea0SLionel Sambuc.Sh SYNOPSIS
49*ebfedea0SLionel Sambuc.In krb5/krb5.h
50*ebfedea0SLionel Sambuc.Ft krb5_error_code
51*ebfedea0SLionel Sambuc.Fn krb5_get_krbhst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
52*ebfedea0SLionel Sambuc.Ft krb5_error_code
53*ebfedea0SLionel Sambuc.Fn krb5_get_krb_admin_hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
54*ebfedea0SLionel Sambuc.Ft krb5_error_code
55*ebfedea0SLionel Sambuc.Fn krb5_get_krb_changepw_hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
56*ebfedea0SLionel Sambuc.Ft krb5_error_code
57*ebfedea0SLionel Sambuc.Fn krb5_get_krb524hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
58*ebfedea0SLionel Sambuc.Ft krb5_error_code
59*ebfedea0SLionel Sambuc.Fn krb5_free_krbhst "krb5_context context" "char **hostlist"
60*ebfedea0SLionel Sambuc.Sh DESCRIPTION
61*ebfedea0SLionel SambucThese functions implement the old API to get a list of Kerberos hosts,
62*ebfedea0SLionel Sambucand are thus similar to the
63*ebfedea0SLionel Sambuc.Fn krb5_krbhst_init
64*ebfedea0SLionel Sambucfunctions. However, since these functions returns
65*ebfedea0SLionel Sambuc.Em all
66*ebfedea0SLionel Sambuchosts in one go, they potentially have to do more lookups than
67*ebfedea0SLionel Sambucnecessary. These functions remain for compatibility reasons.
68*ebfedea0SLionel Sambuc.Pp
69*ebfedea0SLionel SambucAfter a call to one of these functions,
70*ebfedea0SLionel Sambuc.Fa hostlist
71*ebfedea0SLionel Sambucis a
72*ebfedea0SLionel Sambuc.Dv NULL
73*ebfedea0SLionel Sambucterminated list of strings, pointing to the requested Kerberos hosts. These should be freed with
74*ebfedea0SLionel Sambuc.Fn krb5_free_krbhst
75*ebfedea0SLionel Sambucwhen done with.
76*ebfedea0SLionel Sambuc.Sh EXAMPLES
77*ebfedea0SLionel SambucThe following code will print the KDCs of the realm
78*ebfedea0SLionel Sambuc.Dq MY.REALM .
79*ebfedea0SLionel Sambuc.Bd -literal -offset indent
80*ebfedea0SLionel Sambucchar **hosts, **p;
81*ebfedea0SLionel Sambuckrb5_get_krbhst(context, "MY.REALM", &hosts);
82*ebfedea0SLionel Sambucfor(p = hosts; *p; p++)
83*ebfedea0SLionel Sambuc    printf("%s\\n", *p);
84*ebfedea0SLionel Sambuckrb5_free_krbhst(context, hosts);
85*ebfedea0SLionel Sambuc.Ed
86*ebfedea0SLionel Sambuc.\" .Sh BUGS
87*ebfedea0SLionel Sambuc.Sh SEE ALSO
88*ebfedea0SLionel Sambuc.Xr krb5_krbhst_init 3
89