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_mk_req_extended.html
parent	1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff)

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

-rw-r--r--

doc/html/appdev/refs/api/krb5_mk_req_extended.html

1 files changed, 42 insertions, 56 deletions

diff --git a/doc/html/appdev/refs/api/krb5_mk_req_extended.html b/doc/html/appdev/refs/api/krb5_mk_req_extended.html
index 8add87bae307..8378d044fe7b 100644
--- a/doc/html/appdev/refs/api/krb5_mk_req_extended.html
+++ b/doc/html/appdev/refs/api/krb5_mk_req_extended.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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials. — 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,62 +52,56 @@

- <div class="section" id="krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials">

+ <section id="krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials">

<h1>krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.<a class="headerlink" href="#krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials" title="Permalink to this headline">¶</a></h1>

-<dl class="function">

-<dt id="c.krb5_mk_req_extended">

-<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_mk_req_extended</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> ap_req_options</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in_data</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req_extended" title="Permalink to this definition">¶</a></dt>

+<dl class="c function">

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

+<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_mk_req_extended</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">ap_req_options</span></span>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data"><span class="n"><span class="pre">krb5_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_data</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</span></span>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data"><span class="n"><span class="pre">krb5_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req_extended" title="Permalink to this definition">¶</a><br /></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"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p>

+<dl class="field-list">

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

+<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>

<p><strong>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p>

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

+<p><strong>[in]</strong> <strong>ap_req_options</strong> - Options (see AP_OPTS macros)</p>

<p><strong>[in]</strong> <strong>in_data</strong> - Application data to be checksummed in the authenticator, or NULL</p>

<p><strong>[in]</strong> <strong>in_creds</strong> - Credentials for the service with valid ticket and key</p>

-<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REQ</strong> message</p>

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

+<p><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REQ</strong> message</p>

+</dd>

+</dl>

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

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

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

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

</ul>

-</td>

-</tr>

-</tbody>

-</table>

+</dd>

+</dl>

<p>Valid <em>ap_req_options</em> are:</p>

-<li><a class="reference internal" href="../macros/AP_OPTS_USE_SESSION_KEY.html#AP_OPTS_USE_SESSION_KEY" title="AP_OPTS_USE_SESSION_KEY"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SESSION_KEY</span></code></a> - Use the session key when creating the request used for user to user authentication.</li>

-<li><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"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></code></a> - Request a mutual authentication packet from the receiver.</li>

-<li><a class="reference internal" href="../macros/AP_OPTS_USE_SUBKEY.html#AP_OPTS_USE_SUBKEY" title="AP_OPTS_USE_SUBKEY"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SUBKEY</span></code></a> - Generate a subsession key from the current session key obtained from the credentials.</li>

+<li><p>#AP_OPTS_USE_SESSION_KEY - Use the session key when creating the request used for user to user authentication.</p></li>

+<li><p>#AP_OPTS_MUTUAL_REQUIRED - Request a mutual authentication packet from the receiver.</p></li>

+<li><p>#AP_OPTS_USE_SUBKEY - Generate a subsession key from the current session key obtained from the credentials.</p></li>

</ul>

</div></blockquote>

-<p>This function creates a KRB_AP_REQ message using supplied credentials <em>in_creds</em> . <em>auth_context</em> may point to an existing auth context or to NULL, in which case a new one will be created. If <em>in_data</em> is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. Use <a class="reference internal" href="krb5_free_data_contents.html#c.krb5_free_data_contents" title="krb5_free_data_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>outbuf</em> when it is no longer needed.</p>

+<p>This function creates a KRB_AP_REQ message using supplied credentials <em>in_creds</em> . <em>auth_context</em> may point to an existing auth context or to NULL, in which case a new one will be created. If <em>in_data</em> is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. Use krb5_free_data_contents() to free <em>outbuf</em> when it is no longer needed.</p>

</div></blockquote>

<p>On successful return, the authenticator is stored in <em>auth_context</em> with the <em>client</em> and <em>checksum</em> fields nulled out. (This is to prevent pointer-sharing problems; the caller should not need these fields anyway, since the caller supplied them.)</p>

-<p class="first admonition-title">See also</p>

-<p class="last"><a class="reference internal" href="krb5_mk_req.html#c.krb5_mk_req" title="krb5_mk_req"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></code></a></p>

-</div>

+<p class="admonition-title">See also</p>

+<p>krb5_mk_req()</p>

</div>

+</section>

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

</div>

<ul>

<li><a class="reference internal" href="#">krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.</a></li>

@@ -160,6 +145,7 @@

</form>

</div>

</div>

@@ -167,8 +153,8 @@

- <div class="right" ><i>Release: 1.21.2</i><br />

+ <div class="right" ><i>Release: 1.21.3</i><br />

</div>