doc/html/appdev/refs/api/krb5_fwd_tgt_creds.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_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message. &#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_get_default_realm - Retrieve the default realm." href="krb5_get_default_realm.html" />
  30     <link rel="prev" title="krb5_free_principal - Free the storage assigned to a principal." href="krb5_free_principal.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_free_principal.html" title="krb5_free_principal - Free the storage assigned to a principal."
  44             accesskey="P">previous</a> |
  45         <a href="krb5_get_default_realm.html" title="krb5_get_default_realm - Retrieve the default realm."
  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_fwd_tgt_creds -  Get a forwarded TGT and format a KRB-CRED message.">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-fwd-tgt-creds-get-a-forwarded-tgt-and-format-a-krb-cred-message">
  65 <h1>krb5_fwd_tgt_creds -  Get a forwarded TGT and format a KRB-CRED message.<a class="headerlink" href="#krb5-fwd-tgt-creds-get-a-forwarded-tgt-and-format-a-krb-cred-message" title="Permalink to this headline">¶</a></h1>
  66 <dl class="function">
  67 <dt id="c.krb5_fwd_tgt_creds">
  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_fwd_tgt_creds</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>, const char *<em>&nbsp;rhost</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em>&nbsp;client</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em>&nbsp;server</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em>&nbsp;cc</em>, int<em>&nbsp;forwardable</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_fwd_tgt_creds" 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><strong>[in]</strong> <strong>auth_context</strong> - Authentication context</p>
  77 <p><strong>[in]</strong> <strong>rhost</strong> - Remote host</p>
  78 <p><strong>[in]</strong> <strong>client</strong> - Client principal of TGT</p>
  79 <p><strong>[in]</strong> <strong>server</strong> - Principal of server to receive TGT</p>
  80 <p><strong>[in]</strong> <strong>cc</strong> - Credential cache handle (NULL to use default)</p>
  81 <p><strong>[in]</strong> <strong>forwardable</strong> - Whether TGT should be forwardable</p>
  82 <p class="last"><strong>[out]</strong> <strong>outbuf</strong> - KRB-CRED message</p>
  83 </td>
  84 </tr>
  85 </tbody>
  86 </table>
  87 <table class="docutils field-list" frame="void" rules="none">
  88 <col class="field-name" />
  89 <col class="field-body" />
  90 <tbody valign="top">
  91 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first simple">
  92 <li>0   Success</li>
  93 <li>ENOMEM   Insufficient memory</li>
  94 <li>KRB5_PRINC_NOMATCH   Requested principal and ticket do not match</li>
  95 <li>KRB5_NO_TKT_SUPPLIED   Request did not supply a ticket</li>
  96 <li>KRB5_CC_BADNAME   Credential cache name or principal name malformed</li>
  97 </ul>
  98 </td>
  99 </tr>
 100 <tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
 101 <li>Kerberos error codes</li>
 102 </ul>
 103 </td>
 104 </tr>
 105 </tbody>
 106 </table>
 107 <p>Get a TGT for use at the remote host <em>rhost</em> and format it into a KRB-CRED message. If <em>rhost</em> is NULL and <em>server</em> is of type <a class="reference internal" href="../macros/KRB5_NT_SRV_HST.html#KRB5_NT_SRV_HST" title="KRB5_NT_SRV_HST"><code class="xref py py-data docutils literal"><span class="pre">KRB5_NT_SRV_HST</span></code></a> , the second component of <em>server</em> will be used.</p>
 108 </div>
 109
 110
 111           </div>
 112         </div>
 113       </div>
 114         </div>
 115         <div class="sidebar">
 116     <h2>On this page</h2>
 117     <ul>
 118 <li><a class="reference internal" href="#">krb5_fwd_tgt_creds -  Get a forwarded TGT and format a KRB-CRED message.</a></li>
 119 </ul>
 120
 121     <br/>
 122     <h2>Table of contents</h2>
 123     <ul class="current">
 124 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 125 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 126 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 127 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 128 <li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
 129 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 132 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 133 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 134 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 135 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 136 </ul>
 137 </li>
 138 </ul>
 139 </li>
 140 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 141 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 142 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 143 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 144 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 145 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 146 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 147 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 148 </ul>
 149
 150     <br/>
 151     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 152     <h4>Search</h4>
 153     <form class="search" action="../../../search.html" method="get">
 154       <input type="text" name="q" size="18" />
 155       <input type="submit" value="Go" />
 156       <input type="hidden" name="check_keywords" value="yes" />
 157       <input type="hidden" name="area" value="default" />
 158     </form>
 159         </div>
 160         <div class="clearer"></div>
 161       </div>
 162     </div>
 163
 164     <div class="footer-wrapper">
 165         <div class="footer" >
 166             <div class="right" ><i>Release: 1.20.1</i><br />
 167                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2022, MIT.
 168             </div>
 169             <div class="left">
 170
 171         <a href="../../../index.html" title="Full Table of Contents"
 172             >Contents</a> |
 173         <a href="krb5_free_principal.html" title="krb5_free_principal - Free the storage assigned to a principal."
 174             >previous</a> |
 175         <a href="krb5_get_default_realm.html" title="krb5_get_default_realm - Retrieve the default realm."
 176             >next</a> |
 177         <a href="../../../genindex.html" title="General Index"
 178             >index</a> |
 179         <a href="../../../search.html" title="Enter search criteria"
 180             >Search</a> |
 181     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_fwd_tgt_creds -  Get a forwarded TGT and format a KRB-CRED message.">feedback</a>
 182             </div>
 183         </div>
 184     </div>
 185
 186   </body>
 187 </html>