diff options
Diffstat (limited to 'crypto/krb5/doc/html/appdev/refs/api/krb5_sendauth.html')
| -rw-r--r-- | crypto/krb5/doc/html/appdev/refs/api/krb5_sendauth.html | 185 |
1 files changed, 0 insertions, 185 deletions
diff --git a/crypto/krb5/doc/html/appdev/refs/api/krb5_sendauth.html b/crypto/krb5/doc/html/appdev/refs/api/krb5_sendauth.html deleted file mode 100644 index cdf295e6c539..000000000000 --- a/crypto/krb5/doc/html/appdev/refs/api/krb5_sendauth.html +++ /dev/null @@ -1,185 +0,0 @@ - -<!DOCTYPE html> - -<html> - <head> - <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" 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> - <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="next" title="krb5_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials." href="krb5_524_convert_creds.html" /> - <link rel="prev" title="krb5_recvauth_version - Server function for sendauth protocol with version parameter." href="krb5_recvauth_version.html" /> - </head><body> - <div class="header-wrapper"> - <div class="header"> - - - <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1> - - <div class="rel"> - - <a href="../../../index.html" title="Full Table of Contents" - accesskey="C">Contents</a> | - <a href="krb5_recvauth_version.html" title="krb5_recvauth_version - Server function for sendauth protocol with version parameter." - accesskey="P">previous</a> | - <a href="krb5_524_convert_creds.html" title="krb5_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials." - accesskey="N">next</a> | - <a href="../../../genindex.html" title="General Index" - accesskey="I">index</a> | - <a href="../../../search.html" title="Enter search criteria" - accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_sendauth - Client function for sendauth protocol.">feedback</a> - </div> - </div> - </div> - - <div class="content-wrapper"> - <div class="content"> - <div class="document"> - - <div class="documentwrapper"> - <div class="bodywrapper"> - <div class="body" role="main"> - - <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="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"><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_sendauth</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_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">fd</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">appl_version</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</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_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">error</span></span>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part"><span class="n"><span class="pre">krb5_ap_rep_enc_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rep_result</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sendauth" title="Permalink to this definition">¶</a><br /></dt> -<dd></dd></dl> - -<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>fd</strong> - File descriptor that describes network socket</p> -<p><strong>[in]</strong> <strong>appl_version</strong> - Application protocol version to be matched with the receiver’s application version</p> -<p><strong>[in]</strong> <strong>client</strong> - Client principal</p> -<p><strong>[in]</strong> <strong>server</strong> - Server principal</p> -<p><strong>[in]</strong> <strong>ap_req_options</strong> - Options (see AP_OPTS macros)</p> -<p><strong>[in]</strong> <strong>in_data</strong> - Data to be sent to the server</p> -<p><strong>[in]</strong> <strong>in_creds</strong> - Input credentials, or NULL to use <em>ccache</em></p> -<p><strong>[in]</strong> <strong>ccache</strong> - Credential cache</p> -<p><strong>[out]</strong> <strong>error</strong> - If non-null, contains KRB_ERROR message returned from server</p> -<p><strong>[out]</strong> <strong>rep_result</strong> - If non-null and <em>ap_req_options</em> is #AP_OPTS_MUTUAL_REQUIRED, contains the result of mutual authentication exchange</p> -<p><strong>[out]</strong> <strong>out_creds</strong> - If non-null, the retrieved credentials</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> -</dd> -</dl> -<p>This function performs the client side of a sendauth/recvauth exchange by sending and receiving messages over <em>fd</em> .</p> -<p>Credentials may be specified in three ways:</p> -<blockquote> -<div><blockquote> -<div><ul class="simple"> -<li><p>If <em>in_creds</em> is NULL, credentials are obtained with krb5_get_credentials() using the principals <em>client</em> and <em>server</em> . <em>server</em> must be non-null; <em>client</em> may NULL to use the default principal of <em>ccache</em> .</p></li> -<li><p>If <em>in_creds</em> is non-null, but does not contain a ticket, credentials for the exchange are obtained with krb5_get_credentials() using <em>in_creds</em> . In this case, the values of <em>client</em> and <em>server</em> are unused.</p></li> -<li><p>If <em>in_creds</em> is a complete credentials structure, it used directly. In this case, the values of <em>client</em> , <em>server</em> , and <em>ccache</em> are unused.</p></li> -</ul> -</div></blockquote> -<p>If the server is using a different application protocol than that specified in <em>appl_version</em> , an error will be returned.</p> -</div></blockquote> -<p>Use krb5_free_creds() to free <em>out_creds</em> , krb5_free_ap_rep_enc_part() to free <em>rep_result</em> , and krb5_free_error() to free <em>error</em> when they are no longer needed.</p> -<div class="admonition seealso"> -<p class="admonition-title">See also</p> -<p>krb5_recvauth()</p> -</div> -</section> - - - <div class="clearer"></div> - </div> - </div> - </div> - </div> - <div class="sidebar"> - - <h2>On this page</h2> - <ul> -<li><a class="reference internal" href="#">krb5_sendauth - Client function for sendauth protocol.</a></li> -</ul> - - <br/> - <h2>Table of contents</h2> - <ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current"> -<li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li> -<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current"> -<li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li> -<li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li> -<li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li> -</ul> -</li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li> -</ul> - - <br/> - <h4><a href="../../../index.html">Full Table of Contents</a></h4> - <h4>Search</h4> - <form class="search" action="../../../search.html" method="get"> - <input type="text" name="q" size="18" /> - <input type="submit" value="Go" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> - - </div> - <div class="clearer"></div> - </div> - </div> - - <div class="footer-wrapper"> - <div class="footer" > - <div class="right" ><i>Release: 1.21.3</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. - </div> - <div class="left"> - - <a href="../../../index.html" title="Full Table of Contents" - >Contents</a> | - <a href="krb5_recvauth_version.html" title="krb5_recvauth_version - Server function for sendauth protocol with version parameter." - >previous</a> | - <a href="krb5_524_convert_creds.html" title="krb5_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials." - >next</a> | - <a href="../../../genindex.html" title="General Index" - >index</a> | - <a href="../../../search.html" title="Enter search criteria" - >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_sendauth - Client function for sendauth protocol.">feedback</a> - </div> - </div> - </div> - - </body> -</html>
\ No newline at end of file |