doc/html/appdev/refs/api/krb5_auth_con_init.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8     <title>krb5_auth_con_init - Create and initialize an authentication context. &#8212; MIT Kerberos Documentation</title>
   9     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  10     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  11     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  12     <script type="text/javascript">
  13       var DOCUMENTATION_OPTIONS = {
  14         URL_ROOT:    '../../../',
  15         VERSION:     '1.20.1',
  16         COLLAPSE_INDEX: false,
  17         FILE_SUFFIX: '.html',
  18         HAS_SOURCE:  true,
  19         SOURCELINK_SUFFIX: '.txt'
  20       };
  21     </script>
  22     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  23     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  24     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  25     <link rel="author" title="About these documents" href="../../../about.html" />
  26     <link rel="index" title="Index" href="../../../genindex.html" />
  27     <link rel="search" title="Search" href="../../../search.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <link rel="next" title="krb5_auth_con_set_checksum_func - Set a checksum callback in an auth context." href="krb5_auth_con_set_checksum_func.html" />
  30     <link rel="prev" title="krb5_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context." href="krb5_auth_con_getsendsubkey_k.html" />
  31   </head>
  32   <body>
  33     <div class="header-wrapper">
  34         <div class="header">
  35
  36
  37             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  38
  39             <div class="rel">
  40
  41         <a href="../../../index.html" title="Full Table of Contents"
  42             accesskey="C">Contents</a> |
  43         <a href="krb5_auth_con_getsendsubkey_k.html" title="krb5_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context."
  44             accesskey="P">previous</a> |
  45         <a href="krb5_auth_con_set_checksum_func.html" title="krb5_auth_con_set_checksum_func - Set a checksum callback in an auth context."
  46             accesskey="N">next</a> |
  47         <a href="../../../genindex.html" title="General Index"
  48             accesskey="I">index</a> |
  49         <a href="../../../search.html" title="Enter search criteria"
  50             accesskey="S">Search</a> |
  51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_auth_con_init -  Create and initialize an authentication context.">feedback</a>
  52             </div>
  53         </div>
  54     </div>
  55
  56     <div class="content-wrapper">
  57       <div class="content">
  58         <div class="document">
  59
  60       <div class="documentwrapper">
  61         <div class="bodywrapper">
  62           <div class="body" role="main">
  63
  64   <div class="section" id="krb5-auth-con-init-create-and-initialize-an-authentication-context">
  65 <h1>krb5_auth_con_init -  Create and initialize an authentication context.<a class="headerlink" href="#krb5-auth-con-init-create-and-initialize-an-authentication-context" title="Permalink to this headline">¶</a></h1>
  66 <dl class="function">
  67 <dt id="c.krb5_auth_con_init">
  68 <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_auth_con_init</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>&nbsp;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>&nbsp;auth_context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_init" title="Permalink to this definition">¶</a></dt>
  69 <dd></dd></dl>
  70
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <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>
  76 <p class="last"><strong>[out]</strong> <strong>auth_context</strong> - Authentication context</p>
  77 </td>
  78 </tr>
  79 </tbody>
  80 </table>
  81 <table class="docutils field-list" frame="void" rules="none">
  82 <col class="field-name" />
  83 <col class="field-body" />
  84 <tbody valign="top">
  85 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
  86 <li>0   Success; otherwise - Kerberos error codes</li>
  87 </ul>
  88 </td>
  89 </tr>
  90 </tbody>
  91 </table>
  92 <p>This function creates an authentication context to hold configuration and state relevant to krb5 functions for authenticating principals and protecting messages once authentication has occurred.</p>
  93 <p>By default, flags for the context are set to enable the use of the replay cache ( <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_TIME.html#KRB5_AUTH_CONTEXT_DO_TIME" title="KRB5_AUTH_CONTEXT_DO_TIME"><code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> ), but not sequence numbers. Use <a class="reference internal" href="krb5_auth_con_setflags.html#c.krb5_auth_con_setflags" title="krb5_auth_con_setflags"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_setflags()</span></code></a> to change the flags.</p>
  94 <p>The allocated <em>auth_context</em> must be freed with <a class="reference internal" href="krb5_auth_con_free.html#c.krb5_auth_con_free" title="krb5_auth_con_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_free()</span></code></a> when it is no longer needed.</p>
  95 </div>
  96
  97
  98           </div>
  99         </div>
 100       </div>
 101         </div>
 102         <div class="sidebar">
 103     <h2>On this page</h2>
 104     <ul>
 105 <li><a class="reference internal" href="#">krb5_auth_con_init -  Create and initialize an authentication context.</a></li>
 106 </ul>
 107
 108     <br/>
 109     <h2>Table of contents</h2>
 110     <ul class="current">
 111 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 112 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 113 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 114 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 115 <li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
 116 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 117 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 118 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 119 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 120 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 121 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 122 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 123 </ul>
 124 </li>
 125 </ul>
 126 </li>
 127 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 128 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 129 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 130 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 131 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 132 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 133 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 134 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 135 </ul>
 136
 137     <br/>
 138     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 139     <h4>Search</h4>
 140     <form class="search" action="../../../search.html" method="get">
 141       <input type="text" name="q" size="18" />
 142       <input type="submit" value="Go" />
 143       <input type="hidden" name="check_keywords" value="yes" />
 144       <input type="hidden" name="area" value="default" />
 145     </form>
 146         </div>
 147         <div class="clearer"></div>
 148       </div>
 149     </div>
 150
 151     <div class="footer-wrapper">
 152         <div class="footer" >
 153             <div class="right" ><i>Release: 1.20.1</i><br />
 154                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2022, MIT.
 155             </div>
 156             <div class="left">
 157
 158         <a href="../../../index.html" title="Full Table of Contents"
 159             >Contents</a> |
 160         <a href="krb5_auth_con_getsendsubkey_k.html" title="krb5_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context."
 161             >previous</a> |
 162         <a href="krb5_auth_con_set_checksum_func.html" title="krb5_auth_con_set_checksum_func - Set a checksum callback in an auth context."
 163             >next</a> |
 164         <a href="../../../genindex.html" title="General Index"
 165             >index</a> |
 166         <a href="../../../search.html" title="Enter search criteria"
 167             >Search</a> |
 168     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_auth_con_init -  Create and initialize an authentication context.">feedback</a>
 169             </div>
 170         </div>
 171     </div>
 172
 173   </body>
 174 </html>