doc/html/appdev/refs/api/krb5_tkt_creds_init.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   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
   9     <title>krb5_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service. &mdash; MIT Kerberos Documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    '../../../',
  18         VERSION:     '1.15.1',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  24     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  25     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  26     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  27     <link rel="author" title="About these documents" href="../../../about.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />
  30     <link rel="up" title="krb5 API" href="index.html" />
  31     <link rel="next" title="krb5_tkt_creds_step - Get the next KDC request in a TGS exchange." href="krb5_tkt_creds_step.html" />
  32     <link rel="prev" title="krb5_tkt_creds_get_times - Retrieve ticket times from a TGS request context." href="krb5_tkt_creds_get_times.html" />
  33   </head>
  34   <body>
  35     <div class="header-wrapper">
  36         <div class="header">
  37
  38
  39             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  40
  41             <div class="rel">
  42
  43         <a href="../../../index.html" title="Full Table of Contents"
  44             accesskey="C">Contents</a> |
  45         <a href="krb5_tkt_creds_get_times.html" title="krb5_tkt_creds_get_times - Retrieve ticket times from a TGS request context."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_tkt_creds_step.html" title="krb5_tkt_creds_step - Get the next KDC request in a TGS exchange."
  48             accesskey="N">next</a> |
  49         <a href="../../../genindex.html" title="General Index"
  50             accesskey="I">index</a> |
  51         <a href="../../../search.html" title="Enter search criteria"
  52             accesskey="S">Search</a> |
  53     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_tkt_creds_init -  Create a context to get credentials from a KDC&#8217;s Ticket Granting Service.">feedback</a>
  54             </div>
  55         </div>
  56     </div>
  57
  58     <div class="content-wrapper">
  59       <div class="content">
  60         <div class="document">
  61
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <div class="section" id="krb5-tkt-creds-init-create-a-context-to-get-credentials-from-a-kdc-s-ticket-granting-service">
  67 <h1>krb5_tkt_creds_init -  Create a context to get credentials from a KDC&#8217;s Ticket Granting Service.<a class="headerlink" href="#krb5-tkt-creds-init-create-a-context-to-get-credentials-from-a-kdc-s-ticket-granting-service" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_tkt_creds_init">
  70 <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_tkt_creds_init</tt><big>(</big><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_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em>&nbsp;ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em>&nbsp;creds</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em>&nbsp;options</em>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a> *<em>&nbsp;ctx</em><big>)</big><a class="headerlink" href="#c.krb5_tkt_creds_init" title="Permalink to this definition">¶</a></dt>
  71 <dd></dd></dl>
  72
  73 <table class="docutils field-list" frame="void" rules="none">
  74 <col class="field-name" />
  75 <col class="field-body" />
  76 <tbody valign="top">
  77 <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>
  78 <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p>
  79 <p><strong>[in]</strong> <strong>creds</strong> - Input credentials</p>
  80 <p><strong>[in]</strong> <strong>options</strong> - <tt class="xref py py-data docutils literal"><span class="pre">KRB5_GC</span></tt> options for this request.</p>
  81 <p class="last"><strong>[out]</strong> <strong>ctx</strong> - New TGS request context</p>
  82 </td>
  83 </tr>
  84 </tbody>
  85 </table>
  86 <table class="docutils field-list" frame="void" rules="none">
  87 <col class="field-name" />
  88 <col class="field-body" />
  89 <tbody valign="top">
  90 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
  91 <li>0   Success; otherwise - Kerberos error codes</li>
  92 </ul>
  93 </td>
  94 </tr>
  95 </tbody>
  96 </table>
  97 <p>This function prepares to obtain credentials matching <em>creds</em> , either by retrieving them from <em>ccache</em> or by making requests to ticket-granting services beginning with a ticket-granting ticket for the client principal&#8217;s realm.</p>
  98 <p>The resulting TGS acquisition context can be used asynchronously with <a class="reference internal" href="krb5_tkt_creds_step.html#c.krb5_tkt_creds_step" title="krb5_tkt_creds_step"><tt class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_step()</span></tt></a> or synchronously with <a class="reference internal" href="krb5_tkt_creds_get.html#c.krb5_tkt_creds_get" title="krb5_tkt_creds_get"><tt class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_get()</span></tt></a> . See also <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><tt class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></tt></a> for synchronous use.</p>
  99 <p>Use <a class="reference internal" href="krb5_tkt_creds_free.html#c.krb5_tkt_creds_free" title="krb5_tkt_creds_free"><tt class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_free()</span></tt></a> to free <em>ctx</em> when it is no longer needed.</p>
 100 <div class="admonition note">
 101 <p class="first admonition-title">Note</p>
 102 <p class="last">New in 1.9</p>
 103 </div>
 104 </div>
 105
 106
 107           </div>
 108         </div>
 109       </div>
 110         </div>
 111         <div class="sidebar">
 112     <h2>On this page</h2>
 113     <ul>
 114 <li><a class="reference internal" href="#">krb5_tkt_creds_init -  Create a context to get credentials from a KDC&#8217;s Ticket Granting Service.</a></li>
 115 </ul>
 116
 117     <br/>
 118     <h2>Table of contents</h2>
 119     <ul class="current">
 120 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 121 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 122 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 123 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 124 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 125 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 126 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 127 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 128 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 129 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 130 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 131 </ul>
 132 </li>
 133 </ul>
 134 </li>
 135 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 136 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 137 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 138 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 139 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 140 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 141 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 142 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 143 </ul>
 144
 145     <br/>
 146     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 147     <h4>Search</h4>
 148     <form class="search" action="../../../search.html" method="get">
 149       <input type="text" name="q" size="18" />
 150       <input type="submit" value="Go" />
 151       <input type="hidden" name="check_keywords" value="yes" />
 152       <input type="hidden" name="area" value="default" />
 153     </form>
 154         </div>
 155         <div class="clearer"></div>
 156       </div>
 157     </div>
 158
 159     <div class="footer-wrapper">
 160         <div class="footer" >
 161             <div class="right" ><i>Release: 1.15.1</i><br />
 162                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 163             </div>
 164             <div class="left">
 165
 166         <a href="../../../index.html" title="Full Table of Contents"
 167             >Contents</a> |
 168         <a href="krb5_tkt_creds_get_times.html" title="krb5_tkt_creds_get_times - Retrieve ticket times from a TGS request context."
 169             >previous</a> |
 170         <a href="krb5_tkt_creds_step.html" title="krb5_tkt_creds_step - Get the next KDC request in a TGS exchange."
 171             >next</a> |
 172         <a href="../../../genindex.html" title="General Index"
 173             >index</a> |
 174         <a href="../../../search.html" title="Enter search criteria"
 175             >Search</a> |
 176     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_tkt_creds_init -  Create a context to get credentials from a KDC&#8217;s Ticket Granting Service.">feedback</a>
 177             </div>
 178         </div>
 179     </div>
 180
 181   </body>
 182 </html>