diff options
Diffstat (limited to 'doc/doxyout/krb5/man/man3/krb5_keytab.3')
| -rw-r--r-- | doc/doxyout/krb5/man/man3/krb5_keytab.3 | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/doc/doxyout/krb5/man/man3/krb5_keytab.3 b/doc/doxyout/krb5/man/man3/krb5_keytab.3 index 0439732015ef..bfbfece7829f 100644 --- a/doc/doxyout/krb5/man/man3/krb5_keytab.3 +++ b/doc/doxyout/krb5/man/man3/krb5_keytab.3 @@ -1,8 +1,8 @@ -.TH "krb5_keytab" 3 "Fri Jun 7 2019" "Version 7.7.0" "HeimdalKerberos5library" \" -*- nroff -*- +.TH "krb5_keytab" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal Kerberos 5 library" \" -*- nroff -*- .ad l .nh .SH NAME -krb5_keytab +krb5_keytab \- Heimdal Kerberos 5 keytab handling functions .SH SYNOPSIS .br .PP @@ -81,7 +81,7 @@ krb5_keytab .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_add_entry (krb5_context context, krb5_keytab id, krb5_keytab_entry * entry)" Add the entry in `entry' to the keytab `id'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -90,7 +90,7 @@ Add the entry in `entry' to the keytab `id'\&. \fIentry\fP the entry to add .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -99,14 +99,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_close (krb5_context context, krb5_keytab id)" Finish using the keytab in `id'\&. All resources will be released, even on errors\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIid\fP keytab to close\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -115,7 +115,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_kt_compare (krb5_context context, krb5_keytab_entry * entry, krb5_const_principal principal, krb5_kvno vno, krb5_enctype enctype)" Compare `entry' against `principal, vno, enctype'\&. Any of `principal, vno, enctype' might be 0 which acts as a wildcard\&. Return TRUE if they compare the same, FALSE otherwise\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -128,7 +128,7 @@ Compare `entry' against `principal, vno, enctype'\&. Any of `principal, vno, enc \fIenctype\fP encryption type to match, 0 matches all encryption types\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return TRUE or match, FALSE if not matched\&. .RE @@ -137,7 +137,7 @@ Return TRUE or match, FALSE if not matched\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_copy_entry_contents (krb5_context context, const krb5_keytab_entry * in, krb5_keytab_entry * out)" Copy the contents of `in' into `out'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -146,7 +146,7 @@ Copy the contents of `in' into `out'\&. \fIout\fP the copy of the keytab entry, free with \fBkrb5_kt_free_entry()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -155,14 +155,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_default (krb5_context context, krb5_keytab * id)" Set `id' to the default keytab\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIid\fP the new default keytab\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -171,7 +171,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_default_modify_name (krb5_context context, char * name, size_t namesize)" Copy the name of the default modify keytab into `name'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -180,7 +180,7 @@ Copy the name of the default modify keytab into `name'\&. \fInamesize\fP length of name .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -189,7 +189,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_default_name (krb5_context context, char * name, size_t namesize)" copy the name of the default keytab into `name'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -198,7 +198,7 @@ copy the name of the default keytab into `name'\&. \fInamesize\fP length of name .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -207,14 +207,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_destroy (krb5_context context, krb5_keytab id)" Destroy (remove) the keytab in `id'\&. All resources will be released, even on errors, does the equvalment of \fBkrb5_kt_close()\fP on the resources\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIid\fP keytab to destroy\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -223,7 +223,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_end_seq_get (krb5_context context, krb5_keytab id, krb5_kt_cursor * cursor)" Release all resources associated with `cursor'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -232,7 +232,7 @@ Release all resources associated with `cursor'\&. \fIcursor\fP the cursor to free\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -241,14 +241,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_free_entry (krb5_context context, krb5_keytab_entry * entry)" Free the contents of `entry'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIentry\fP the entry to free .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -257,7 +257,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_get_entry (krb5_context context, krb5_keytab id, krb5_const_principal principal, krb5_kvno kvno, krb5_enctype enctype, krb5_keytab_entry * entry)" Retrieve the keytab entry for `principal, kvno, enctype' into `entry' from the keytab `id'\&. Matching is done like \fBkrb5_kt_compare()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -272,7 +272,7 @@ Retrieve the keytab entry for `principal, kvno, enctype' into `entry' from the k \fIentry\fP the returned entry, free with \fBkrb5_kt_free_entry()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -281,7 +281,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_get_full_name (krb5_context context, krb5_keytab keytab, char ** str)" Retrieve the full name of the keytab `keytab' and store the name in `str'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -290,7 +290,7 @@ Retrieve the full name of the keytab `keytab' and store the name in `str'\&. \fIstr\fP the name of the keytab name, usee krb5_xfree() to free the string\&. On error, *str is set to NULL\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -299,7 +299,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_get_name (krb5_context context, krb5_keytab keytab, char * name, size_t namesize)" Retrieve the name of the keytab `keytab' into `name', `namesize' .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -310,7 +310,7 @@ Retrieve the name of the keytab `keytab' into `name', `namesize' \fInamesize\fP size of name buffer\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -319,7 +319,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_get_type (krb5_context context, krb5_keytab keytab, char * prefix, size_t prefixsize)" Return the type of the `keytab' in the string \fCprefix of length \fPprefixsize'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -330,7 +330,7 @@ Return the type of the `keytab' in the string \fCprefix of length \fPprefixsize' \fIprefixsize\fP length of prefix buffer .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -339,14 +339,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_have_content (krb5_context context, krb5_keytab id)" Return true if the keytab exists and have entries .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIid\fP a keytab\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -355,7 +355,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_next_entry (krb5_context context, krb5_keytab id, krb5_keytab_entry * entry, krb5_kt_cursor * cursor)" Get the next entry from keytab, advance the cursor\&. On last entry the function will return KRB5_KT_END\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -366,7 +366,7 @@ Get the next entry from keytab, advance the cursor\&. On last entry the function \fIcursor\fP the cursor of the iteration\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -375,7 +375,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_read_service_key (krb5_context context, krb5_pointer keyprocarg, krb5_principal principal, krb5_kvno vno, krb5_enctype enctype, krb5_keyblock ** key)" Read the key identified by `(principal, vno, enctype)' from the keytab in `keyprocarg' (the default if == NULL) into `*key'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -390,7 +390,7 @@ Read the key identified by `(principal, vno, enctype)' from the keytab in `keypr \fIkey\fP .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -399,14 +399,14 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_register (krb5_context context, const krb5_kt_ops * ops)" Register a new keytab backend\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br \fIops\fP a backend to register\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -415,7 +415,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_remove_entry (krb5_context context, krb5_keytab id, krb5_keytab_entry * entry)" Remove an entry from the keytab, matching is done using \fBkrb5_kt_compare()\fP\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -424,7 +424,7 @@ Remove an entry from the keytab, matching is done using \fBkrb5_kt_compare()\fP\ \fIentry\fP the entry to remove .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -433,7 +433,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_resolve (krb5_context context, const char * name, krb5_keytab * id)" Resolve the keytab name (of the form `type:residual') in `name' into a keytab in `id'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -442,7 +442,7 @@ Resolve the keytab name (of the form `type:residual') in `name' into a keytab in \fIid\fP resulting keytab, free with \fBkrb5_kt_close()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -451,7 +451,7 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_kt_start_seq_get (krb5_context context, krb5_keytab id, krb5_kt_cursor * cursor)" Set `cursor' to point at the beginning of `id'\&. .PP -\fBParameters:\fP +\fBParameters\fP .RS 4 \fIcontext\fP a Keberos context\&. .br @@ -460,7 +460,7 @@ Set `cursor' to point at the beginning of `id'\&. \fIcursor\fP a newly allocated cursor, free with \fBkrb5_kt_end_seq_get()\fP\&. .RE .PP -\fBReturns:\fP +\fBReturns\fP .RS 4 Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .RE @@ -468,4 +468,4 @@ Return an error code or 0, see \fBkrb5_get_error_message()\fP\&. .SH "Author" .PP -Generated automatically by Doxygen for HeimdalKerberos5library from the source code\&. +Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code\&. |