summaryrefslogtreecommitdiff
path: root/kerberosV
diff options
context:
space:
mode:
authorBjorn Sandell <biorn@cvs.openbsd.org>2006-06-13 07:07:22 +0000
committerBjorn Sandell <biorn@cvs.openbsd.org>2006-06-13 07:07:22 +0000
commit3de304b38562bcf12128f2290166acafb883fff2 (patch)
tree9249c8fee0aeaaa6a07f744d3533d12886efcb00 /kerberosV
parent2b75dad143f49702efaf7b7b9de4b2668188654a (diff)
Grammar fixes, both mdoc & english.
Improved and approved by jmc@
Diffstat (limited to 'kerberosV')
-rw-r--r--kerberosV/src/lib/krb5/krb5_acl_match_file.357
-rw-r--r--kerberosV/src/lib/krb5/krb5_c_make_checksum.32
-rw-r--r--kerberosV/src/lib/krb5/krb5_config.3287
-rw-r--r--kerberosV/src/lib/krb5/krb5_get_in_cred.314
-rw-r--r--kerberosV/src/lib/krb5/krb5_get_init_creds.320
-rw-r--r--kerberosV/src/lib/krb5/krb5_is_thread_safe.32
-rw-r--r--kerberosV/src/lib/krb5/krb5_ticket.32
-rw-r--r--kerberosV/src/lib/roken/parse_time.32
8 files changed, 305 insertions, 81 deletions
diff --git a/kerberosV/src/lib/krb5/krb5_acl_match_file.3 b/kerberosV/src/lib/krb5/krb5_acl_match_file.3
index 09e28348ee8..e790a626104 100644
--- a/kerberosV/src/lib/krb5/krb5_acl_match_file.3
+++ b/kerberosV/src/lib/krb5/krb5_acl_match_file.3
@@ -37,7 +37,7 @@
.Sh NAME
.Nm krb5_acl_match_file ,
.Nm krb5_acl_match_string
-.Nd ACL matching functions .
+.Nd ACL matching functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
@@ -63,48 +63,49 @@ Lines starting with # are treated like comments and ignored.
.Nm krb5_acl_match_string
matches ACL format against a string.
.Pp
-The ACL format have tree format specifiers, s, f, r.
-Each specifier will pull of one argument from the varable arguments
-for ether maching or storing data.
-The input string is split up using " " and "\t" as delimiter, multiple
-" " and "\t" in a row are considered to be the same.
+The ACL format has three format specifiers: s, f and r.
+Each specifier will retrieve one argument from the variable arguments
+for either matching or storing data.
+The input string is split up using " " and "\et" as a delimiter; multiple
+" " and "\et" in a row are considered to be the same.
.Pp
-.Bl -tag -width "f" -offset indent
+.Bl -tag -width "fXX" -offset indent
.It s
-matches a string using strcmp (case sensetive).
+Matches a string using
+.Xr strcmp 3
+(case sensitive).
.It f
-matches the string with
+Matches the string with
.Xr fnmatch 3 .
-The
+The
.Fa flags
-argument (the last argument) passed to the fnmatch function is 0.
+argument (the last argument) passed to the fnmatch function is 0.
.It r
-returns a copy the string in the char ** passed in, the copy must be
+Returns a copy of the string in the char ** passed in; the copy must be
freed with
.Xr free 3 .
There is no need to
.Xr free 3
-the string on error, the function will clean up and set the pointer to
+the string on error: the function will clean up and set the pointer to
.Dv NULL .
.El
.Pp
-All unknown format specifiers causes an error.
-.Pp
+All unknown format specifiers cause an error.
.Sh EXAMPLES
-.Bd -literal
- char *s;
+.Bd -literal -offset indent
+char *s;
- ret = krb5_acl_match_string(context, "foo", "s", "foo");
- if (ret)
- krb5_errx(context, 1, "acl didn't match");
- ret = krb5_acl_match_string(context, "foo foo baz/kaka",
- "ss", "foo", &s, "foo/*");
- if (ret) {
- /* no need to free(s) on error */
- assert(s == NULL);
- krb5_errx(context, 1, "acl didn't match");
- }
- free(s);
+ret = krb5_acl_match_string(context, "foo", "s", "foo");
+if (ret)
+ krb5_errx(context, 1, "acl didn't match");
+ret = krb5_acl_match_string(context, "foo foo baz/kaka",
+ "ss", "foo", &s, "foo/*");
+if (ret) {
+ /* no need to free(s) on error */
+ assert(s == NULL);
+ krb5_errx(context, 1, "acl didn't match");
+}
+free(s);
.Ed
.Sh SEE ALSO
.Xr krb5 3
diff --git a/kerberosV/src/lib/krb5/krb5_c_make_checksum.3 b/kerberosV/src/lib/krb5/krb5_c_make_checksum.3
index f82f3e4a323..01b40cb011a 100644
--- a/kerberosV/src/lib/krb5/krb5_c_make_checksum.3
+++ b/kerberosV/src/lib/krb5/krb5_c_make_checksum.3
@@ -50,7 +50,7 @@
.Nm krb5_c_valid_enctype ,
.Nm krb5_c_verify_checksum ,
.Nm krb5_c_checksum_length
-.Nd Kerberos crypto API
+.Nd Kerberos 5 crypto API
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
diff --git a/kerberosV/src/lib/krb5/krb5_config.3 b/kerberosV/src/lib/krb5/krb5_config.3
index 4e43e826edd..bffbde3173f 100644
--- a/kerberosV/src/lib/krb5/krb5_config.3
+++ b/kerberosV/src/lib/krb5/krb5_config.3
@@ -1,71 +1,294 @@
-.\" Copyright (c) 2000 Kungliga Tekniska Högskolan
-.\" $KTH: krb5_config.3,v 1.1 2000/07/25 10:22:46 joda Exp $
-.Dd July 25, 2000
-.Dt KRB5_CONFIG 3
+.\" Copyright (c) 2000 - 2004 Kungliga Tekniska Högskolan
+.\" (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_config.3,v 1.8 2004/03/20 18:15:01 lha Exp $
+.\"
+.Dd March 20, 2004
+.Dt KRB5_CONFIG_GET 3
.Os HEIMDAL
.Sh NAME
+.Nm krb5_config_file_free ,
+.Nm krb5_config_free_strings ,
+.Nm krb5_config_get ,
+.Nm krb5_config_get_bool ,
.Nm krb5_config_get_bool_default ,
+.Nm krb5_config_get_int ,
.Nm krb5_config_get_int_default ,
+.Nm krb5_config_get_list ,
+.Nm krb5_config_get_next ,
+.Nm krb5_config_get_string ,
.Nm krb5_config_get_string_default ,
-.Nm krb5_config_get_time_default
-.Nd Get configuration value
-
+.Nm krb5_config_get_strings ,
+.Nm krb5_config_get_time ,
+.Nm krb5_config_get_time_default ,
+.Nm krb5_config_parse_file ,
+.Nm krb5_config_parse_file_multi ,
+.Nm krb5_config_vget ,
+.Nm krb5_config_vget_bool ,
+.Nm krb5_config_vget_bool_default ,
+.Nm krb5_config_vget_int ,
+.Nm krb5_config_vget_int_default ,
+.Nm krb5_config_vget_list ,
+.Nm krb5_config_vget_next ,
+.Nm krb5_config_vget_string ,
+.Nm krb5_config_vget_string_default ,
+.Nm krb5_config_vget_strings ,
+.Nm krb5_config_vget_time ,
+.Nm krb5_config_vget_time_default
+.Nd get configuration value
+.Sh LIBRARY
+Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
-.Fd #include <krb5.h>
-
+.In krb5.h
+.Ft krb5_error_code
+.Fo krb5_config_file_free
+.Fa "krb5_context context"
+.Fa "krb5_config_section *s"
+.Fc
+.Ft void
+.Fo krb5_config_free_strings
+.Fa "char **strings"
+.Fc
+.Ft "const void *"
+.Fo krb5_config_get
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "int type"
+.Fa "..."
+.Fc
.Ft krb5_boolean
-.Fn krb5_config_get_bool_default "krb5_context context" "krb5_config_section *c" "krb5_boolean def_value" "..."
+.Fo krb5_config_get_bool
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "..."
+.Fc
+.Ft krb5_boolean
+.Fo krb5_config_get_bool_default
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "krb5_boolean def_value"
+.Fa "..."
+.Fc
+.Ft int
+.Fo krb5_config_get_int
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "..."
+.Fc
.Ft int
-.Fn krb5_config_get_int_default "krb5_context context" "krb5_config_section *c" "int def_value" "..."
+.Fo krb5_config_get_int_default
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "int def_value"
+.Fa "..."
+.Fc
.Ft const char*
-.Fn krb5_config_get_string_default "krb5_context context" "krb5_config_section *c" "const char *def_value" "..."
+.Fo krb5_config_get_string
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "..."
+.Fc
+.Ft const char*
+.Fo krb5_config_get_string_default
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "const char *def_value"
+.Fa "..."
+.Fc
+.Ft "char**"
+.Fo krb5_config_get_strings
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "..."
+.Fc
+.Ft int
+.Fo krb5_config_get_time
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "..."
+.Fc
+.Ft int
+.Fo krb5_config_get_time_default
+.Fa "krb5_context context"
+.Fa "krb5_config_section *c"
+.Fa "int def_value"
+.Fa "..."
+.Fc
+.Ft krb5_error_code
+.Fo krb5_config_parse_file
+.Fa "krb5_context context"
+.Fa "const char *fname"
+.Fa "krb5_config_section **res"
+.Fc
+.Ft krb5_error_code
+.Fo krb5_config_parse_file_multi
+.Fa "krb5_context context"
+.Fa "const char *fname"
+.Fa "krb5_config_section **res"
+.Fc
+.Ft "const void *"
+.Fo krb5_config_vget
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "int type"
+.Fa "va_list args"
+.Fc
+.Ft krb5_boolean
+.Fo krb5_config_vget_bool
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft krb5_boolean
+.Fo krb5_config_vget_bool_default
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "krb5_boolean def_value"
+.Fa "va_list args"
+.Fc
.Ft int
-.Fn krb5_config_get_time_default "krb5_context context" "krb5_config_section *c" "int def_value" "..."
-
+.Fo krb5_config_vget_int
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft int
+.Fo krb5_config_vget_int_default
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "int def_value"
+.Fa "va_list args"
+.Fc
+.Ft "const krb5_config_binding *"
+.Fo krb5_config_vget_list
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft "const void *"
+.Fo krb5_config_vget_next
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "const krb5_config_binding **pointer"
+.Fa "int type"
+.Fa "va_list args"
+.Fc
+.Ft "const char *"
+.Fo krb5_config_vget_string
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft "const char *"
+.Fo krb5_config_vget_string_default
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "const char *def_value"
+.Fa "va_list args"
+.Fc
+.Ft char **
+.Fo krb5_config_vget_strings
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft int
+.Fo krb5_config_vget_time
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "va_list args"
+.Fc
+.Ft int
+.Fo krb5_config_vget_time_default
+.Fa "krb5_context context"
+.Fa "const krb5_config_section *c"
+.Fa "int def_value"
+.Fa "va_list args"
+.Fc
.Sh DESCRIPTION
-
-These functions get values from the
-.Xr krb5.conf 5
+These functions get values from the
+.Xr krb5.conf 5
configuration file, or another configuration database specified by the
.Fa c
parameter.
-
+.Pp
The variable arguments should be a list of strings naming each
subsection to look for. For example:
-
.Bd -literal -offset indent
-krb5_config_get_bool_default(context, NULL, FALSE, "libdefaults", "log_utc", NULL)
+krb5_config_get_bool_default(context, NULL, FALSE,
+ "libdefaults", "log_utc", NULL);
.Ed
-
+.Pp
gets the boolean value for the
.Dv log_utc
option, defaulting to
.Dv FALSE .
-
+.Pp
.Fn krb5_config_get_bool_default
will convert the option value to a boolean value, where
-.Sq yes ,
+.Sq yes ,
.Sq true ,
and any non-zero number means
.Dv TRUE ,
-and any other value
+and any other value
.Dv FALSE .
-
+.Pp
.Fn krb5_config_get_int_default
will convert the value to an integer.
-
+.Pp
.Fn krb5_config_get_time_default
will convert the value to a period of time (not a time stamp) in
seconds, so the string
.Sq 2 weeks
will be converted to
1209600 (2 * 7 * 24 * 60 * 60).
-
-.Sh BUGS
-
-Other than for the string case, there's no way to tell whether there
-was a value specified or not.
-
+.Pp
+.Fn krb5_config_free_strings
+free
+.Fa strings
+as returned by
+.Fn krb5_config_get_strings
+and
+.Fn krb5_config_vget_strings .
+.Pp
+.Fn krb5_config_file_free
+free the result of
+.Fn krb5_config_parse_file
+and
+.Fn krb5_config_parse_file_multi .
.Sh SEE ALSO
.Xr krb5_appdefault 3 ,
+.Xr krb5_init_context 3 ,
.Xr krb5.conf 5
+.Sh BUGS
+For the default functions, other than for the string case, there's no
+way to tell whether there was a value specified or not.
diff --git a/kerberosV/src/lib/krb5/krb5_get_in_cred.3 b/kerberosV/src/lib/krb5/krb5_get_in_cred.3
index ab0b2cf1fc0..73d904a630a 100644
--- a/kerberosV/src/lib/krb5/krb5_get_in_cred.3
+++ b/kerberosV/src/lib/krb5/krb5_get_in_cred.3
@@ -42,7 +42,7 @@
.Nm krb5_get_in_tkt_with_skey ,
.Nm krb5_free_kdc_rep ,
.Nm krb5_password_key_proc
-.Nd krb5 ticket functions
+.Nd deprecated initial authentication functions
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
@@ -120,7 +120,7 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fa "krb5_kdc_rep *rep"
.Fc
.Ft krb5_error_code
-.Fo krb5_password_key_proc
+.Fo krb5_password_key_proc
.Fa "krb5_context context"
.Fa "krb5_enctype type"
.Fa "krb5_salt salt"
@@ -130,10 +130,10 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Sh DESCRIPTION
.Bf Em
All the functions in this manual page are deprecated in the MIT
-implementation, and will soon deprecated in Heimdal too, do't use them.
+implementation, and will soon deprecated in Heimdal too, don't use them.
.Ef
.Pp
-Getting initial credential ticket for a principal.
+Getting initial credential ticket for a principal.
.Nm krb5_get_in_cred
is the function all other krb5_get_in function uses to fetch tickets.
The other krb5_get_in function are more specialized and therefor
@@ -239,12 +239,12 @@ Upon return of the function it will be contain the content of the
requested credential
.Fa ( krb5_get_in_cred ) ,
or it will be freed with
-.Xr krb5_free_creds 3
+.Xr krb5_free_creds 3
(all the other krb5_get_in functions).
.Pp
.Fa ccache
will store the credential in the credential cache
-.Fa ccache.
+.Fa ccache .
The credential cache will not be initialized, thats up the the caller.
.Pp
.Nm krb5_password_key_proc
@@ -261,7 +261,7 @@ terminated string or
.Dv NULL .
.Nm krb5_password_key_proc
will query the user for the pass on the console if the password isn't
-given as the argument
+given as the argument
.Fa keyseed .
.Pp
.Fn krb5_free_kdc_rep
diff --git a/kerberosV/src/lib/krb5/krb5_get_init_creds.3 b/kerberosV/src/lib/krb5/krb5_get_init_creds.3
index 902ea72d879..572fd71a41f 100644
--- a/kerberosV/src/lib/krb5/krb5_get_init_creds.3
+++ b/kerberosV/src/lib/krb5/krb5_get_init_creds.3
@@ -98,7 +98,7 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fo krb5_get_init_creds_opt_set_etype_list
.Fa "krb5_get_init_creds_opt *opt"
.Fa "krb5_enctype *etype_list"
-.Fa int etype_list_length"
+.Fa "int etype_list_length"
.Fc
.Ft void
.Fo krb5_get_init_creds_opt_set_forwardable
@@ -205,7 +205,7 @@ and
.Fa krb5_in_cred
functions.
.Pp
-If you only to verify a user and password, consider using
+If you only want to verify a username and password, consider using
.Xr krb5_verify_user 3
instead, since it also verifies that initial credentials with using a
keytab to make sure the response was from the KDC.
@@ -236,8 +236,8 @@ or
functions.
.Fn krb5_get_init_creds
is the least specialized function and can, with the right in data,
-behave like the later two.
-The later two are there for compatibly with older releases and that
+behave like the latter two.
+The latter two are there for compatibility with older releases and
they are slightly easier to use.
.Pp
.Li krb5_prompt
@@ -258,7 +258,7 @@ If
is set, the prompter function shouldn't echo the output to the display
device.
.Fa reply
-must be preallocated, it will not be allocated in by the prompter
+must be preallocated; it will not be allocated by the prompter
function.
Possible values for the
.Fa type
@@ -271,7 +271,7 @@ element are:
.El
.Pp
.Fn krb5_prompter_posix
-is a the default prompter function in a posix environment.
+is a the default prompter function in a POSIX environment.
It matches the
.Fa krb5_prompter_fct
and can be used in the
@@ -334,16 +334,16 @@ or
.Fa key_proc
can be
.Dv NULL
-if the caller what to use the default values.
+if the caller wants to use the default values.
If the
.Fa password
-is unset and needed, the use will be prompted for it.
+is unset and needed, the user will be prompted for it.
.Pp
.Fn krb5_get_init_creds_opt_set_paq_request
sets the password that is going to be used to get a new ticket.
.Pp
.Fn krb5_get_init_creds_opt_set_preauth_list
-sets the list of client supported preauth types.
+sets the list of client-supported preauth types.
.Pp
.Fn krb5_get_init_creds_opt_set_proxiable
makes the request proxiable.
@@ -352,7 +352,7 @@ makes the request proxiable.
sets the requested renewable lifetime.
.Pp
.Fn krb5_get_init_creds_opt_set_salt
-sets that that is going to be used in the request.
+sets the salt that is going to be used in the request.
.Pp
.Fn krb5_get_init_creds_opt_set_tkt_life
sets requested ticket lifetime.
diff --git a/kerberosV/src/lib/krb5/krb5_is_thread_safe.3 b/kerberosV/src/lib/krb5/krb5_is_thread_safe.3
index a676e19664d..c07e719b1e9 100644
--- a/kerberosV/src/lib/krb5/krb5_is_thread_safe.3
+++ b/kerberosV/src/lib/krb5/krb5_is_thread_safe.3
@@ -36,7 +36,7 @@
.Os HEIMDAL
.Sh NAME
.Nm krb5_is_thread_safe
-.Nd "returns TRUE if the Kerberos 5 library was compiled with multithread support"
+.Nd "is the Kerberos library compiled with multithread support"
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
diff --git a/kerberosV/src/lib/krb5/krb5_ticket.3 b/kerberosV/src/lib/krb5/krb5_ticket.3
index 930cace2ee1..e536e018160 100644
--- a/kerberosV/src/lib/krb5/krb5_ticket.3
+++ b/kerberosV/src/lib/krb5/krb5_ticket.3
@@ -88,7 +88,7 @@ functions exist for extracting information.
.Fn krb5_free_ticket
frees the
.Fa ticket
-and its content .
+and its content.
Used to free the result of
.Fn krb5_copy_ticket
and
diff --git a/kerberosV/src/lib/roken/parse_time.3 b/kerberosV/src/lib/roken/parse_time.3
index b055a89ea18..d0d5d381363 100644
--- a/kerberosV/src/lib/roken/parse_time.3
+++ b/kerberosV/src/lib/roken/parse_time.3
@@ -37,7 +37,7 @@
.Nm parse_time ,
.Nm print_time_table ,
.Nm unparse_time ,
-.Nm unparse_time_approx ,
+.Nm unparse_time_approx
.Nd parse and unparse time intervals
.Sh LIBRARY
The roken library (libroken, -lroken)