diff options
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 | 36 |
1 files changed, 17 insertions, 19 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 e77bd6712e74..625f134837df 100644 --- a/doc/html/appdev/refs/api/krb5_mk_req_extended.html +++ b/doc/html/appdev/refs/api/krb5_mk_req_extended.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"> - <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - - <title>krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials. — MIT Kerberos Documentation</title> - + <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.16', + VERSION: '1.21.1', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', - HAS_SOURCE: true + 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="author" title="About these documents" href="../../../about.html" /> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> <link rel="copyright" title="Copyright" href="../../../copyright.html" /> - <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" /> - <link rel="up" title="krb5 API" href="index.html" /> <link rel="next" title="krb5_mk_safe - Format a KRB-SAFE message." href="krb5_mk_safe.html" /> <link rel="prev" title="krb5_mk_req - Create a KRB_AP_REQ message." href="krb5_mk_req.html" /> </head> @@ -61,13 +59,13 @@ <div class="documentwrapper"> <div class="bodywrapper"> - <div class="body"> + <div class="body" role="main"> <div class="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> <tt class="descname">krb5_mk_req_extended</tt><big>(</big><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><big>)</big><a class="headerlink" href="#c.krb5_mk_req_extended" 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_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> <dd></dd></dl> <table class="docutils field-list" frame="void" rules="none"> @@ -76,7 +74,7 @@ <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> <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> - <tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS</span></tt> options</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>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> @@ -99,17 +97,17 @@ <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/AP_OPTS_USE_SESSION_KEY.html#AP_OPTS_USE_SESSION_KEY" title="AP_OPTS_USE_SESSION_KEY"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SESSION_KEY</span></tt></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"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></tt></a> - Request a mutual authentication packet from the reciever.</li> -<li><a class="reference internal" href="../macros/AP_OPTS_USE_SUBKEY.html#AP_OPTS_USE_SUBKEY" title="AP_OPTS_USE_SUBKEY"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SUBKEY</span></tt></a> - Generate a subsession key from the current session key obtained from the credentials.</li> +<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> </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"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_data_contents()</span></tt></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 <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> </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> <div class="admonition seealso"> <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"><tt class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></tt></a></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> </div> @@ -169,8 +167,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.16</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT. + <div class="right" ><i>Release: 1.21.1</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. </div> <div class="left"> |