summaryrefslogtreecommitdiff
path: root/kerberosV
diff options
context:
space:
mode:
authorBjorn Sandell <biorn@cvs.openbsd.org>2005-04-24 20:18:48 +0000
committerBjorn Sandell <biorn@cvs.openbsd.org>2005-04-24 20:18:48 +0000
commit4fe0d50418e4c2653818243c3dbcf0e5bdc59215 (patch)
tree41623aa139d773706f0c58592b6e57b1a3214238 /kerberosV
parent879323ed84438d1562ddaa1dc5dfa891a8e30d70 (diff)
A bunch of small fixes, both mdoc and english.
ok jmc@ and beck@
Diffstat (limited to 'kerberosV')
-rw-r--r--kerberosV/src/lib/krb5/kerberos.82
-rw-r--r--kerberosV/src/lib/krb5/krb5_address.331
-rw-r--r--kerberosV/src/lib/krb5/krb5_aname_to_localname.34
-rw-r--r--kerberosV/src/lib/krb5/krb5_data.320
-rw-r--r--kerberosV/src/lib/krb5/krb5_get_krbhst.362
-rw-r--r--kerberosV/src/lib/krb5/krb5_krbhst_init.364
-rw-r--r--kerberosV/src/lib/krb5/krb5_kuserok.36
-rw-r--r--kerberosV/src/lib/krb5/krb5_set_default_realm.34
8 files changed, 126 insertions, 67 deletions
diff --git a/kerberosV/src/lib/krb5/kerberos.8 b/kerberosV/src/lib/krb5/kerberos.8
index c1e450bc19b..422a6d0b94d 100644
--- a/kerberosV/src/lib/krb5/kerberos.8
+++ b/kerberosV/src/lib/krb5/kerberos.8
@@ -97,7 +97,7 @@ of these issues work on version five started, and resulted in IETF
RFC1510 in 1993. Since then much work has been put into the further
development, and a new RFC will hopefully appear soon.
.Pp
-This manual manual page is part of the
+This manual page is part of the
.Nm Heimdal
Kerberos 5 distribution, which has been in development at the Royal
Institute of Technology in Stockholm, Sweden, since about 1997.
diff --git a/kerberosV/src/lib/krb5/krb5_address.3 b/kerberosV/src/lib/krb5/krb5_address.3
index 5867662ea87..2931fd4e7de 100644
--- a/kerberosV/src/lib/krb5/krb5_address.3
+++ b/kerberosV/src/lib/krb5/krb5_address.3
@@ -213,7 +213,7 @@ from
.Fa addr
and
.Fa port .
-.Fa Sa_size
+.Fa sa_size
should be initially contain the size of the
.Fa sa ,
and after the call, it will contain the actual length of the address.
@@ -228,7 +228,7 @@ returns
.Dv TRUE
for all
.Fa sa
-that for that the kerberos library thinks are uninteresting.
+that the kerberos library thinks are uninteresting.
One example are link local addresses.
.Pp
.Fn krb5_h_addr2sockaddr
@@ -243,12 +243,10 @@ and the
.Xr gethostbyname 3 )
.Fa h_addr_list
component.
-.Fa Sa_size
-should be initially contain the size of the
+.Fa sa_size
+should initially contain the size of the
.Fa sa ,
and after the call, it will contain the actual length of the address.
-.Fa sa
-argument.
.Pp
.Fn krb5_h_addr2addr
works like
@@ -256,16 +254,16 @@ works like
with the exception that it operates on a
.Li krb5_address
instead of a
-.Li struct sockaddr
+.Li struct sockaddr .
.Pp
.Fn krb5_anyaddr
fills in a
.Li "struct sockaddr"
.Fa sa
that can be used to
-.Xf bind 3
+.Xr bind 2
to.
-.Fa Sa_size
+.Fa sa_size
should be initially contain the size of the
.Fa sa ,
and after the call, it will contain the actual length of the address.
@@ -273,38 +271,39 @@ and after the call, it will contain the actual length of the address.
.Fn krb5_print_address
prints the address in
.Fa addr
-to the a string
+to the string
.Fa string
that have the length
.Fa len .
If
.Fa ret_len
-if not
+is not
.Dv NULL ,
-it will be filled in length of the string.
+it will be filled with the length of the string.
.Pp
.Fn krb5_parse_address
-Returns the resolving a hostname in
+Returns the resolved hostname in
.Fa string
to the
.Li krb5_addresses
.Fa addresses .
.Pp
.Fn krb5_address_order
-compares to addresses
+compares the addresses
.Fa addr1
and
.Fa addr2
so that it can be used for sorting addresses. If the addresses are the
same address
-.Fa krb5_address_order will be return 0.
+.Fa krb5_address_order
+will return 0.
.Pp
.Fn krb5_address_compare
compares the addresses
.Fa addr1
and
.Fa addr2 .
-returns
+Returns
.Dv TRUE
if the two addresses are the same.
.Pp
diff --git a/kerberosV/src/lib/krb5/krb5_aname_to_localname.3 b/kerberosV/src/lib/krb5/krb5_aname_to_localname.3
index 2e896978a0f..70f156e7eef 100644
--- a/kerberosV/src/lib/krb5/krb5_aname_to_localname.3
+++ b/kerberosV/src/lib/krb5/krb5_aname_to_localname.3
@@ -57,9 +57,9 @@ and then returns the local name of the principal.
.Pp
If
.Fa name
-isn't in one of the local realms and error is returned.
+isn't in one of the local realms an error is returned.
.Pp
-If size
+If the size
.Fa ( lnsize )
of the local name
.Fa ( lname )
diff --git a/kerberosV/src/lib/krb5/krb5_data.3 b/kerberosV/src/lib/krb5/krb5_data.3
index 27bb59a4f09..6624a6ea164 100644
--- a/kerberosV/src/lib/krb5/krb5_data.3
+++ b/kerberosV/src/lib/krb5/krb5_data.3
@@ -35,14 +35,14 @@
.Dt KRB5_DATA 3
.Os HEIMDAL
.Sh NAME
-.Nm krb5_data
-.Nm krb5_data_zero
-.Nm krb5_data_free
-.Nm krb5_free_data_contents
-.Nm krb5_free_data
-.Nm krb5_data_alloc
-.Nm krb5_data_realloc
-.Nm krb5_data_copy
+.Nm krb5_data ,
+.Nm krb5_data_zero ,
+.Nm krb5_data_free ,
+.Nm krb5_free_data_contents ,
+.Nm krb5_free_data ,
+.Nm krb5_data_alloc ,
+.Nm krb5_data_realloc ,
+.Nm krb5_data_copy ,
.Nm krb5_copy_data
.Nd operates on the Kerberos datatype krb5_data.
.Sh LIBRARY
@@ -99,13 +99,13 @@ frees the data in
.Fa p
and
.Fa p
-itself .
+itself.
.Pp
.Fn krb5_data_alloc
allocates
.Fa len
bytes in
-.Fa p
+.Fa p .
Returns 0 or an error.
.Pp
.Fn krb5_data_realloc
diff --git a/kerberosV/src/lib/krb5/krb5_get_krbhst.3 b/kerberosV/src/lib/krb5/krb5_get_krbhst.3
index c0bd3c2ffd0..1f876b386a0 100644
--- a/kerberosV/src/lib/krb5/krb5_get_krbhst.3
+++ b/kerberosV/src/lib/krb5/krb5_get_krbhst.3
@@ -1,18 +1,50 @@
.\" Copyright (c) 2001 Kungliga Tekniska Högskolan
-.\" $KTH: krb5_get_krbhst.3,v 1.1 2001/06/16 23:00:43 joda Exp $
+.\" (Royal Institute of Technology, Stockholm, Sweden).
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" 3. Neither the name of the Institute nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $KTH: krb5_get_krbhst.3,v 1.6 2003/04/16 13:58:16 lha Exp $
+.\"
.Dd June 17, 2001
.Dt KRB5_GET_KRBHST 3
.Os HEIMDAL
.Sh NAME
-.Nm krb5_get_krbhst
-.Nm krb5_get_krb_admin_hst
-.Nm krb5_get_krb_changepw_hst
-.Nm krb5_get_krb524hst
+.Nm krb5_get_krbhst ,
+.Nm krb5_get_krb_admin_hst ,
+.Nm krb5_get_krb_changepw_hst ,
+.Nm krb5_get_krb524hst ,
.Nm krb5_free_krbhst
.Nd lookup Kerberos KDC hosts
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
-.Fd #include <krb5.h>
-
+.In krb5.h
.Ft krb5_error_code
.Fn krb5_get_krbhst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
.Ft krb5_error_code
@@ -23,28 +55,24 @@
.Fn krb5_get_krb524hst "krb5_context context" "const krb5_realm *realm" "char ***hostlist"
.Ft krb5_error_code
.Fn krb5_free_krbhst "krb5_context context" "char **hostlist"
-
.Sh DESCRIPTION
-
These functions implement the old API to get a list of Kerberos hosts,
and are thus similar to the
-.Fn krb5_krbhst_init
-functions. However, since these functions returns
+.Fn krb5_krbhst_init
+functions. However, since these functions returns
.Em all
hosts in one go, they potentially have to do more lookups than
necessary. These functions remain for compatibility reasons.
.Pp
After a call to one of these functions,
-.Fa hostlist
+.Fa hostlist
is a
.Dv NULL
terminated list of strings, pointing to the requested Kerberos hosts. These should be freed with
-.Fn krb5_free_krbhst
+.Fn krb5_free_krbhst
when done with.
-
-
-.Sh EXAMPLE
-The following code will print the KDCs of the realm
+.Sh EXAMPLES
+The following code will print the KDCs of the realm
.Dq MY.REALM .
.Bd -literal -offset indent
char **hosts, **p;
diff --git a/kerberosV/src/lib/krb5/krb5_krbhst_init.3 b/kerberosV/src/lib/krb5/krb5_krbhst_init.3
index 5c28b56cca2..ca582764c53 100644
--- a/kerberosV/src/lib/krb5/krb5_krbhst_init.3
+++ b/kerberosV/src/lib/krb5/krb5_krbhst_init.3
@@ -1,5 +1,36 @@
.\" Copyright (c) 2001 Kungliga Tekniska Högskolan
-.\" $KTH: krb5_krbhst_init.3,v 1.2 2001/06/21 14:35:21 assar Exp $
+.\" (Royal Institute of Technology, Stockholm, Sweden).
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" 3. Neither the name of the Institute nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $KTH: krb5_krbhst_init.3,v 1.7 2003/04/16 13:58:16 lha Exp $
+.\"
.Dd June 17, 2001
.Dt KRB5_KRBHST_INIT 3
.Os HEIMDAL
@@ -12,9 +43,10 @@
.Nm krb5_krbhst_format_string ,
.Nm krb5_krbhst_get_addrinfo
.Nd lookup Kerberos KDC hosts
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
-.Fd #include <krb5.h>
-
+.In krb5.h
.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
@@ -36,10 +68,10 @@ administrative servers, the password changing servers, or the servers
for Kerberos 4 ticket conversion.
.Pp
First a handle to a particular service is obtained by calling
-.Fn krb5_krbhst_init
-with the
+.Fn krb5_krbhst_init
+with the
.Fa realm
-of interest and the type of service to lookup. The
+of interest and the type of service to lookup. The
.Fa type
can be one of:
.Pp
@@ -55,9 +87,9 @@ The
is returned to the caller, and should be passed to the other
functions.
.Pp
-For each call to
+For each call to
.Fn krb5_krbhst_next
-information a new host is returned. The former function returns in
+information on a new host is returned. The former function returns in
.Fa host
a pointer to a structure containing information about the host, such
as protocol, hostname, and port:
@@ -73,7 +105,7 @@ typedef struct krb5_krbhst_info {
} krb5_krbhst_info;
.Ed
.Pp
-The related function,
+The related function,
.Fn krb5_krbhst_next_as_string ,
return the same information as a url-like string.
.Pp
@@ -82,11 +114,11 @@ When there are no more hosts, these functions return
.Pp
To re-iterate over all hosts, call
.Fn krb5_krbhst_reset
-and the next call to
+and the next call to
.Fn krb5_krbhst_next
will return the first host.
.Pp
-When done with the handle,
+When done with the handle,
.Fn krb5_krbhst_free
should be called.
.Pp
@@ -101,13 +133,13 @@ that will return a
.Va struct addrinfo
that can then be used for communicating with the server mentioned.
.Sh EXAMPLE
-The following code will print the KDCs of the realm
-.Dq MY.REALM .
+The following code will print the KDCs of the realm
+.Dq MY.REALM :
.Bd -literal -offset indent
krb5_krbhst_handle handle;
char host[MAXHOSTNAMELEN];
krb5_krbhst_init(context, "MY.REALM", KRB5_KRBHST_KDC, &handle);
-while(krb5_krbhst_next_as_string(context, handle,
+while(krb5_krbhst_next_as_string(context, handle,
host, sizeof(host)) == 0)
printf("%s\\n", host);
krb5_krbhst_free(context, handle);
@@ -116,5 +148,5 @@ krb5_krbhst_free(context, handle);
.Sh HISTORY
These functions first appeared in Heimdal 0.3g.
.Sh SEE ALSO
-.Xr krb5_get_krbhst 3 ,
-.Xr getaddrinfo 3
+.Xr getaddrinfo 3 ,
+.Xr krb5_get_krbhst 3
diff --git a/kerberosV/src/lib/krb5/krb5_kuserok.3 b/kerberosV/src/lib/krb5/krb5_kuserok.3
index df902a647b6..3e1c35453c4 100644
--- a/kerberosV/src/lib/krb5/krb5_kuserok.3
+++ b/kerberosV/src/lib/krb5/krb5_kuserok.3
@@ -36,7 +36,7 @@
.Os HEIMDAL
.Sh NAME
.Nm krb5_kuserok
-.Nd verifies if a principal can log in as a user
+.Nd "verifies if a principal can log in as a user"
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
@@ -80,7 +80,7 @@ If it does exists,
.Dv TRUE
is returned.
If neither of the above turns out to be true,
-.DV FALSE
+.Dv FALSE
is returned.
.Pp
The
@@ -90,5 +90,5 @@ should contain one principal per line.
.Xr krb5_get_default_realms 3 ,
.Xr krb5_verify_user 3 ,
.Xr krb5_verify_user_lrealm 3 ,
-.Xr krb5_verify_user_opt 3,
+.Xr krb5_verify_user_opt 3 ,
.Xr krb5.conf 5
diff --git a/kerberosV/src/lib/krb5/krb5_set_default_realm.3 b/kerberosV/src/lib/krb5/krb5_set_default_realm.3
index 1e43094d9df..7ec673bb533 100644
--- a/kerberosV/src/lib/krb5/krb5_set_default_realm.3
+++ b/kerberosV/src/lib/krb5/krb5_set_default_realm.3
@@ -78,7 +78,7 @@ frees all memory allocated by
.Pp
.Fn krb5_get_default_realm
returns the first default realm for this host.
-The realm returned should be free with
+The realm returned should be freed with
.Fn free .
.Pp
.Fn krb5_get_default_realms
@@ -87,7 +87,7 @@ returns a
terminated list of default realms for this context.
Realms returned by
.Fn krb5_get_default_realms
-should be free with
+should be freed with
.Fn krb5_free_host_realm .
.Pp
.Fn krb5_get_host_realm