krb5: Import MIT 1.21.3 - src - FreeBSD source tree

diff options


context:
space:
mode:

author	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
committer	Cy Schubert <cy@FreeBSD.org>	2025-03-19 22:12:25 +0000
commit	8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch)
tree	9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/appdev/refs/api/krb5_sendauth.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

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

-rw-r--r--

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

100

1 files changed, 43 insertions, 57 deletions

diff --git a/doc/html/appdev/refs/api/krb5_sendauth.html b/doc/html/appdev/refs/api/krb5_sendauth.html
index 9d4a6fca4a46..cdf295e6c539 100644
--- a/doc/html/appdev/refs/api/krb5_sendauth.html
+++ b/doc/html/appdev/refs/api/krb5_sendauth.html

@@ -1,35 +1,26 @@

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

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

+<!DOCTYPE html>

-<html xmlns="http://www.w3.org/1999/xhtml">

+<html>

<head>

- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

+ <meta charset="utf-8" />

+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

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

- <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />

- <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />

- <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />

- <script type="text/javascript">

- var DOCUMENTATION_OPTIONS = {

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

- VERSION: '1.21.2',

- COLLAPSE_INDEX: false,

- FILE_SUFFIX: '.html',

- HAS_SOURCE: true,

- SOURCELINK_SUFFIX: '.txt'

- };

- </script>

- <script type="text/javascript" src="../../../_static/jquery.js"></script>

- <script type="text/javascript" src="../../../_static/underscore.js"></script>

- <script type="text/javascript" src="../../../_static/doctools.js"></script>

+ <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css" />

+ <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css" />

+ <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>

+ <script src="../../../_static/jquery.js"></script>

+ <script src="../../../_static/underscore.js"></script>

+ <script src="../../../_static/doctools.js"></script>

- </head>

- <body>

+ </head><body>

@@ -61,70 +52,64 @@

- <div class="section" id="krb5-sendauth-client-function-for-sendauth-protocol">

+ <section id="krb5-sendauth-client-function-for-sendauth-protocol">

<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>

-<dl class="function">

-<dt id="c.krb5_sendauth">

-<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>

+<dl class="c function">

+<dt class="sig sig-object c" id="c.krb5_sendauth">

+<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> krb5_sendauth(<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>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

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

+<dl class="field-list">

+<dt class="field-odd">param</dt>

+<dd class="field-odd">[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] client - Client principal

[in] server - Server principal

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

+[in] ap_req_options - Options (see AP_OPTS macros)

[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"><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>

-</tbody>

-</table>

-<table class="docutils field-list" frame="void" rules="none">

-<col class="field-name" />

-<col class="field-body" />

-<tbody valign="top">

-<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">

-<li>0 Success; otherwise - Kerberos error codes</li>

+[out] rep_result - If non-null and ap_req_options is #AP_OPTS_MUTUAL_REQUIRED, contains the result of mutual authentication exchange

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

+</dd>

+</dl>

+<dl class="field-list simple">

+<dt class="field-odd">retval</dt>

+<dd class="field-odd"><ul class="simple">

+<li>0 Success; otherwise - Kerberos error codes</li>

</ul>

-</td>

-</tr>

-</tbody>

-</table>

+</dd>

+</dl>

This function performs the client side of a sendauth/recvauth exchange by sending and receiving messages over fd .

Credentials may be specified in three ways:

-<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>

+<li>If in_creds is NULL, credentials are obtained with krb5_get_credentials() 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 krb5_get_credentials() 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"><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.

+Use krb5_free_creds() to free out_creds , krb5_free_ap_rep_enc_part() to free rep_result , and krb5_free_error() 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"><code class="xref c c-func docutils literal">krb5_recvauth()</code></a>

-</div>

+See also

+krb5_recvauth()

</div>

+</section>

+ <div class="clearer"></div>

</div>

<ul>

<li><a class="reference internal" href="#">krb5_sendauth - Client function for sendauth protocol.</a></li>

@@ -168,6 +153,7 @@

</form>

</div>

</div>

@@ -175,8 +161,8 @@

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

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

</div>