aboutsummaryrefslogtreecommitdiff
path: root/doc/doxyout/krb5/man/man3/krb5_credential.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/doxyout/krb5/man/man3/krb5_credential.3')
-rw-r--r--doc/doxyout/krb5/man/man3/krb5_credential.340
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/doxyout/krb5/man/man3/krb5_credential.3 b/doc/doxyout/krb5/man/man3/krb5_credential.3
index 0f0be790116b..2950a0e02e42 100644
--- a/doc/doxyout/krb5/man/man3/krb5_credential.3
+++ b/doc/doxyout/krb5/man/man3/krb5_credential.3
@@ -1,8 +1,8 @@
-.TH "krb5_credential" 3 "Fri Jun 7 2019" "Version 7.7.0" "HeimdalKerberos5library" \" -*- nroff -*-
+.TH "krb5_credential" 3 "Tue Nov 15 2022" "Version 7.8.0" "Heimdal Kerberos 5 library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-krb5_credential
+krb5_credential \- Heimdal Kerberos 5 credential handing functions
.SH SYNOPSIS
.br
.PP
@@ -63,7 +63,7 @@ krb5_credential
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_fwd_tgt_creds (krb5_context context, krb5_auth_context auth_context, const char * hostname, krb5_principal client, krb5_principal server, krb5_ccache ccache, int forwardable, krb5_data * out_data)"
Forward credentials for client to host hostname , making them forwardable if forwardable, and returning the blob of data to sent in out_data\&. If hostname == NULL, pick it from server\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP A kerberos 5 context\&.
.br
@@ -82,7 +82,7 @@ Forward credentials for client to host hostname , making them forwardable if for
\fIout_data\fP the resulting credential\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
Return an error code or 0\&.
.RE
@@ -93,7 +93,7 @@ Gets tickets forwarded to hostname\&. If the tickets that are forwarded are addr
.PP
If the ticket have any address, hostname will be used for figure out the address to forward the ticket too\&. This since this might use DNS, its insecure and also doesn't represent configured all addresses of the host\&. For example, the host might have two adresses, one IPv4 and one IPv6 address where the later is not published in DNS\&. This IPv6 address might be used communications and thus the resulting ticket useless\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP A kerberos 5 context\&.
.br
@@ -110,7 +110,7 @@ If the ticket have any address, hostname will be used for figure out the address
\fIout_data\fP the resulting credential\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
Return an error code or 0\&.
.RE
@@ -129,7 +129,7 @@ Get new credentials using password\&.
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_creds_free (krb5_context context, krb5_init_creds_context ctx)"
Free the krb5_init_creds_context allocated by \fBkrb5_init_creds_init()\fP\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
@@ -140,7 +140,7 @@ Free the krb5_init_creds_context allocated by \fBkrb5_init_creds_init()\fP\&.
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get (krb5_context context, krb5_init_creds_context ctx)"
Get new credentials as setup by the krb5_init_creds_context\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
@@ -151,7 +151,7 @@ Get new credentials as setup by the krb5_init_creds_context\&.
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get_error (krb5_context context, krb5_init_creds_context ctx, KRB_ERROR * error)"
Get the last error from the transaction\&.
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
Returns 0 or an error code
.RE
@@ -160,7 +160,7 @@ Returns 0 or an error code
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_init (krb5_context context, krb5_principal client, krb5_prompter_fct prompter, void * prompter_data, krb5_deltat start_time, krb5_get_init_creds_opt * options, krb5_init_creds_context * rctx)"
Start a new context to get a new initial credential\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP A Kerberos 5 context\&.
.br
@@ -177,7 +177,7 @@ Start a new context to get a new initial credential\&.
\fIrctx\fP A new allocated free with \fBkrb5_init_creds_free()\fP\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
0 for success or an Kerberos 5 error code, see \fBkrb5_get_error_message()\fP\&.
.RE
@@ -186,7 +186,7 @@ Start a new context to get a new initial credential\&.
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_keytab (krb5_context context, krb5_init_creds_context ctx, krb5_keytab keytab)"
Set the keytab to use for authentication\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP a Kerberos 5 context\&.
.br
@@ -195,7 +195,7 @@ Set the keytab to use for authentication\&.
\fIkeytab\fP the keytab to read the key from\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
0 for success, or an Kerberos 5 error code, see \fBkrb5_get_error_message()\fP\&.
.RE
@@ -204,7 +204,7 @@ Set the keytab to use for authentication\&.
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_password (krb5_context context, krb5_init_creds_context ctx, const char * password)"
Sets the password that will use for the request\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP a Kerberos 5 context\&.
.br
@@ -213,7 +213,7 @@ Sets the password that will use for the request\&.
\fIpassword\fP the password to use\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
0 for success, or an Kerberos 5 error code, see \fBkrb5_get_error_message()\fP\&.
.RE
@@ -222,7 +222,7 @@ Sets the password that will use for the request\&.
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_service (krb5_context context, krb5_init_creds_context ctx, const char * service)"
Sets the service that the is requested\&. This call is only neede for special initial tickets, by default the a krbtgt is fetched in the default realm\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP a Kerberos 5 context\&.
.br
@@ -231,7 +231,7 @@ Sets the service that the is requested\&. This call is only neede for special in
\fIservice\fP the service given as a string, for example 'kadmind/admin'\&. If NULL, the default krbtgt in the clients realm is set\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
0 for success, or an Kerberos 5 error code, see \fBkrb5_get_error_message()\fP\&.
.RE
@@ -242,7 +242,7 @@ The core loop if krb5_get_init_creds() function family\&. Create the packets and
.PP
If the caller want all work been done for them, use \fBkrb5_init_creds_get()\fP instead\&.
.PP
-\fBParameters:\fP
+\fBParameters\fP
.RS 4
\fIcontext\fP a Kerberos 5 context\&.
.br
@@ -257,7 +257,7 @@ If the caller want all work been done for them, use \fBkrb5_init_creds_get()\fP
\fIflags\fP status of the round, if KRB5_INIT_CREDS_STEP_FLAG_CONTINUE is set, continue one more round\&.
.RE
.PP
-\fBReturns:\fP
+\fBReturns\fP
.RS 4
0 for success, or an Kerberos 5 error code, see \fBkrb5_get_error_message()\fP\&.
.RE
@@ -265,4 +265,4 @@ If the caller want all work been done for them, use \fBkrb5_init_creds_get()\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\&.