oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

document krb5_krbhst_init_flags

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13556 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2004-03-20 11:03:39 +00:00
parent 94e9280b53
commit c4d325a9be
1 changed files with 24 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
lib/krb5/krb5_krbhst_init.3
View File

@@ -36,6 +36,7 @@
.Os HEIMDAL
.Sh NAME
.Nm krb5_krbhst_init ,
.Nm krb5_krbhst_init_flags ,
.Nm krb5_krbhst_next ,
.Nm krb5_krbhst_next_as_string ,
.Nm krb5_krbhst_reset ,
@@ -50,6 +51,8 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Ft krb5_error_code
.Fn krb5_krbhst_init "krb5_context context" "const char *realm" "unsigned int type" "krb5_krbhst_handle *handle"
.Ft krb5_error_code
.Fn krb5_krbhst_init_flags "krb5_context context" "const char *realm" "unsigned int type" "int flags" "krb5_krbhst_handle *handle"
.Ft krb5_error_code
.Fn "krb5_krbhst_next" "krb5_context context" "krb5_krbhst_handle handle" "krb5_krbhst_info **host"
.Ft krb5_error_code
.Fn krb5_krbhst_next_as_string "krb5_context context" "krb5_krbhst_handle handle" "char *hostname" "size_t hostlen"
@@ -69,13 +72,15 @@ for Kerberos 4 ticket conversion.
.Pp
First a handle to a particular service is obtained by calling
.Fn krb5_krbhst_init
(or
.Fn krb5_krbhst_init_flags )
with the
.Fa realm
of interest and the type of service to lookup. The
.Fa type
can be one of:
.Pp
.Bl -hang -compact -offset indent
.Bl -tag -compact -offset indent
.It KRB5_KRBHST_KDC
.It KRB5_KRBHST_ADMIN
.It KRB5_KRBHST_CHANGEPW
@@ -87,6 +92,22 @@ The
is returned to the caller, and should be passed to the other
functions.
.Pp
The
.Fa flag
argument to
.Nm krb5_krbhst_init_flags
is the same flags as
.Fn krb5_send_to_kdc_flags
uses.
Possible values are:
.Pp
.Bl -tag -compact -offset indent
.It KRB5_KRBHST_FLAGS_MASTER
only talk to master (readwrite) KDC
.It KRB5_KRBHST_FLAGS_LARGE_MSG
this is a large message, so use transport that can handle that.
.El
.Pp
For each call to
.Fn krb5_krbhst_next
information a new host is returned. The former function returns in
@@ -147,6 +168,7 @@ krb5_krbhst_free(context, handle);
.\" .Sh BUGS
.Sh SEE ALSO
.Xr getaddrinfo 3 ,
.Xr krb5_get_krbhst 3
.Xr krb5_get_krbhst 3 ,
.Xr krb5_send_to_kdc_flags 3
.Sh HISTORY
These functions first appeared in Heimdal 0.3g.