doc/html/appdev/refs/api/krb5_get_credentials.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_get_credentials - Get an additional ticket. &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_get_fallback_host_realm" href="krb5_get_fallback_host_realm.html" />
  32     <link rel="prev" title="krb5_get_host_realm - Get the Kerberos realm names for a host." href="krb5_get_host_realm.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_get_host_realm.html" title="krb5_get_host_realm - Get the Kerberos realm names for a host."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_get_fallback_host_realm.html" title="krb5_get_fallback_host_realm"
  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_get_credentials -  Get an additional ticket.">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-get-credentials-get-an-additional-ticket">
  67 <h1>krb5_get_credentials -  Get an additional ticket.<a class="headerlink" href="#krb5-get-credentials-get-an-additional-ticket" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_get_credentials">
  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_get_credentials</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_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em>&nbsp;options</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;in_creds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em>&nbsp;out_creds</em><big>)</big><a class="headerlink" href="#c.krb5_get_credentials" 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>options</strong> - Options</p>
  79 <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p>
  80 <p><strong>[in]</strong> <strong>in_creds</strong> - Input credentials</p>
  81 <p class="last"><strong>[out]</strong> <strong>out_creds</strong> - Output updated credentials</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 simple">
  91 <li>0   Success</li>
  92 </ul>
  93 </td>
  94 </tr>
  95 <tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
  96 <li>Kerberos error codes</li>
  97 </ul>
  98 </td>
  99 </tr>
 100 </tbody>
 101 </table>
 102 <p>Use <em>ccache</em> or a TGS exchange to get a service ticket matching <em>in_creds</em> .</p>
 103 <p>Valid values for <em>options</em> are:</p>
 104 <blockquote>
 105 <div><blockquote>
 106 <div><ul class="simple">
 107 <li><a class="reference internal" href="../macros/KRB5_GC_CACHED.html#KRB5_GC_CACHED" title="KRB5_GC_CACHED"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_GC_CACHED</span></tt></a> Search only credential cache for the ticket</li>
 108 <li><a class="reference internal" href="../macros/KRB5_GC_USER_USER.html#KRB5_GC_USER_USER" title="KRB5_GC_USER_USER"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_GC_USER_USER</span></tt></a> Return a user to user authentication ticket</li>
 109 </ul>
 110 </div></blockquote>
 111 <p><em>in_creds</em> must be non-null. <em>in_creds-&gt;client</em> and <em>in_creds-&gt;server</em> must be filled in to specify the client and the server respectively. If any authorization data needs to be requested for the service ticket (such as restrictions on how the ticket can be used), specify it in <em>in_creds-&gt;authdata</em> ; otherwise set <em>in_creds-&gt;authdata</em> to NULL. The session key type is specified in <em>in_creds-&gt;keyblock.enctype</em> , if it is nonzero.</p>
 112 </div></blockquote>
 113 <p>The expiration date is specified in <em>in_creds-&gt;times.endtime</em> . The KDC may return tickets with an earlier expiration date. If <em>in_creds-&gt;times.endtime</em> is set to 0, the latest possible expiration date will be requested.</p>
 114 <p>Any returned ticket and intermediate ticket-granting tickets are stored in <em>ccache</em> .</p>
 115 <p>Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></tt></a> to free <em>out_creds</em> when it is no longer needed.</p>
 116 </div>
 117
 118
 119           </div>
 120         </div>
 121       </div>
 122         </div>
 123         <div class="sidebar">
 124     <h2>On this page</h2>
 125     <ul>
 126 <li><a class="reference internal" href="#">krb5_get_credentials -  Get an additional ticket.</a></li>
 127 </ul>
 128
 129     <br/>
 130     <h2>Table of contents</h2>
 131     <ul class="current">
 132 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 133 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 134 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 135 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 138 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 139 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 140 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 141 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 142 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 143 </ul>
 144 </li>
 145 </ul>
 146 </li>
 147 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 148 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 149 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 150 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 151 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 152 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 153 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 154 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 155 </ul>
 156
 157     <br/>
 158     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 159     <h4>Search</h4>
 160     <form class="search" action="../../../search.html" method="get">
 161       <input type="text" name="q" size="18" />
 162       <input type="submit" value="Go" />
 163       <input type="hidden" name="check_keywords" value="yes" />
 164       <input type="hidden" name="area" value="default" />
 165     </form>
 166         </div>
 167         <div class="clearer"></div>
 168       </div>
 169     </div>
 170
 171     <div class="footer-wrapper">
 172         <div class="footer" >
 173             <div class="right" ><i>Release: 1.15.1</i><br />
 174                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 175             </div>
 176             <div class="left">
 177
 178         <a href="../../../index.html" title="Full Table of Contents"
 179             >Contents</a> |
 180         <a href="krb5_get_host_realm.html" title="krb5_get_host_realm - Get the Kerberos realm names for a host."
 181             >previous</a> |
 182         <a href="krb5_get_fallback_host_realm.html" title="krb5_get_fallback_host_realm"
 183             >next</a> |
 184         <a href="../../../genindex.html" title="General Index"
 185             >index</a> |
 186         <a href="../../../search.html" title="Enter search criteria"
 187             >Search</a> |
 188     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_get_credentials -  Get an additional ticket.">feedback</a>
 189             </div>
 190         </div>
 191     </div>
 192
 193   </body>
 194 </html>