krb5: Update to 1.21.1 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2023-08-04 17:53:10 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2023-08-04 17:53:10 +0000
commit	0320e0d5bb9fbb5da53478b3fd80ad79b110191d (patch)
tree	e1185f75bd2d3f87b0c17f787debc3ee8648214b /doc/html/appdev/refs/api/krb5_sendauth.html
parent	b0e4d68d5124581ae353493d69bea352de4cff8a (diff)

vendor/krb5/1.21.1

Diffstat (limited to 'doc/html/appdev/refs/api/krb5_sendauth.html')

-rw-r--r--

doc/html/appdev/refs/api/krb5_sendauth.html

1 files changed, 18 insertions, 20 deletions

diff --git a/doc/html/appdev/refs/api/krb5_sendauth.html b/doc/html/appdev/refs/api/krb5_sendauth.html
index ec271b9c379a..cccaef7119cf 100644
--- a/doc/html/appdev/refs/api/krb5_sendauth.html
+++ b/doc/html/appdev/refs/api/krb5_sendauth.html

@@ -1,33 +1,31 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

- <title>krb5_sendauth - Client function for sendauth protocol. — MIT Kerberos Documentation</title>

+ <title>krb5_sendauth - Client function for sendauth protocol. — MIT Kerberos Documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../../',

- VERSION: '1.16',

+ VERSION: '1.21.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

- HAS_SOURCE: true

+ HAS_SOURCE: true,

+ SOURCELINK_SUFFIX: '.txt'

};

</script>

+ <link rel="index" title="Index" href="../../../genindex.html" />

+ <link rel="search" title="Search" href="../../../search.html" />

- <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />

- <link rel="up" title="krb5 API" href="index.html" />

</head>

@@ -61,13 +59,13 @@

- <div class="body">

+ <div class="body" role="main">

<h1>krb5_sendauth - Client function for sendauth protocol.<a class="headerlink" href="#krb5-sendauth-client-function-for-sendauth-protocol" title="Permalink to this headline">¶</a></h1>

-<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_sendauth</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> context, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> * auth_context, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a> fd, char * appl_version, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> client, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> server, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a> ap_req_options, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * in_data, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> * in_creds, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> ccache, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> ** error, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part">krb5_ap_rep_enc_part</a> ** rep_result, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> ** out_creds<big>)</big><a class="headerlink" href="#c.krb5_sendauth" title="Permalink to this definition">¶</a></dt>

+<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <code class="descname">krb5_sendauth</code>(<a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> context, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> * auth_context, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a> fd, char * appl_version, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> client, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> server, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a> ap_req_options, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * in_data, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> * in_creds, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> ccache, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> ** error, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part">krb5_ap_rep_enc_part</a> ** rep_result, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> ** out_creds)<a class="headerlink" href="#c.krb5_sendauth" title="Permalink to this definition">¶</a></dt>

@@ -77,15 +75,15 @@

<tr class="field-odd field"><th class="field-name">param:</th><td class="field-body">[in] context - Library context

[inout] auth_context - Pre-existing or newly created auth context

[in] fd - File descriptor that describes network socket

-[in] appl_version - Application protocol version to be matched with the receiver’s application version

+[in] appl_version - Application protocol version to be matched with the receiver’s application version

[in] client - Client principal

[in] server - Server principal

-[in] ap_req_options - <tt class="xref py py-data docutils literal">AP_OPTS</tt> options

+[in] ap_req_options - <code class="xref py py-data docutils literal">AP_OPTS</code> options

[in] in_data - Data to be sent to the server

[in] in_creds - Input credentials, or NULL to use ccache

[in] ccache - Credential cache

[out] error - If non-null, contains KRB_ERROR message returned from server

-[out] rep_result - If non-null and ap_req_options is <a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><tt class="xref py py-data docutils literal">AP_OPTS_MUTUAL_REQUIRED</tt></a> , contains the result of mutual authentication exchange

+[out] rep_result - If non-null and ap_req_options is <a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><code class="xref py py-data docutils literal">AP_OPTS_MUTUAL_REQUIRED</code></a> , contains the result of mutual authentication exchange

[out] out_creds - If non-null, the retrieved credentials

</td>

</tr>

@@ -107,17 +105,17 @@

-<li>If in_creds is NULL, credentials are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><tt class="xref c c-func docutils literal">krb5_get_credentials()</tt></a> using the principals client and server . server must be non-null; client may NULL to use the default principal of ccache .</li>

-<li>If in_creds is non-null, but does not contain a ticket, credentials for the exchange are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><tt class="xref c c-func docutils literal">krb5_get_credentials()</tt></a> using in_creds . In this case, the values of client and server are unused.</li>

+<li>If in_creds is NULL, credentials are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal">krb5_get_credentials()</code></a> using the principals client and server . server must be non-null; client may NULL to use the default principal of ccache .</li>

+<li>If in_creds is non-null, but does not contain a ticket, credentials for the exchange are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal">krb5_get_credentials()</code></a> using in_creds . In this case, the values of client and server are unused.</li>

<li>If in_creds is a complete credentials structure, it used directly. In this case, the values of client , server , and ccache are unused.</li>

</ul>

</div></blockquote>

If the server is using a different application protocol than that specified in appl_version , an error will be returned.

</div></blockquote>

-Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><tt class="xref c c-func docutils literal">krb5_free_creds()</tt></a> to free out_creds , <a class="reference internal" href="krb5_free_ap_rep_enc_part.html#c.krb5_free_ap_rep_enc_part" title="krb5_free_ap_rep_enc_part"><tt class="xref c c-func docutils literal">krb5_free_ap_rep_enc_part()</tt></a> to free rep_result , and <a class="reference internal" href="krb5_free_error.html#c.krb5_free_error" title="krb5_free_error"><tt class="xref c c-func docutils literal">krb5_free_error()</tt></a> to free error when they are no longer needed.

+Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal">krb5_free_creds()</code></a> to free out_creds , <a class="reference internal" href="krb5_free_ap_rep_enc_part.html#c.krb5_free_ap_rep_enc_part" title="krb5_free_ap_rep_enc_part"><code class="xref c c-func docutils literal">krb5_free_ap_rep_enc_part()</code></a> to free rep_result , and <a class="reference internal" href="krb5_free_error.html#c.krb5_free_error" title="krb5_free_error"><code class="xref c c-func docutils literal">krb5_free_error()</code></a> to free error when they are no longer needed.

See also

-<a class="reference internal" href="krb5_recvauth.html#c.krb5_recvauth" title="krb5_recvauth"><tt class="xref c c-func docutils literal">krb5_recvauth()</tt></a>

+<a class="reference internal" href="krb5_recvauth.html#c.krb5_recvauth" title="krb5_recvauth"><code class="xref c c-func docutils literal">krb5_recvauth()</code></a>

</div>

@@ -177,8 +175,8 @@

- <div class="right" >Release: 1.16

+ <div class="right" >Release: 1.21.1

</div>