diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_get_credentials.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_get_credentials.html | 98 |
1 files changed, 42 insertions, 56 deletions
diff --git a/doc/html/appdev/refs/api/krb5_get_credentials.html b/doc/html/appdev/refs/api/krb5_get_credentials.html index ef276ed649ae..bb68b8f9fd9b 100644 --- a/doc/html/appdev/refs/api/krb5_get_credentials.html +++ b/doc/html/appdev/refs/api/krb5_get_credentials.html @@ -1,35 +1,26 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml"> +<html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <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_get_credentials - Get an additional ticket. — MIT Kerberos Documentation</title> - <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" /> - <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" /> - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '../../../', - VERSION: '1.21.2', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' - }; - </script> - <script type="text/javascript" src="../../../_static/jquery.js"></script> - <script type="text/javascript" src="../../../_static/underscore.js"></script> - <script type="text/javascript" src="../../../_static/doctools.js"></script> + <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_get_fallback_host_realm" href="krb5_get_fallback_host_realm.html" /> <link rel="prev" title="krb5_get_host_realm - Get the Kerberos realm names for a host." href="krb5_get_host_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,64 +52,58 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-credentials-get-an-additional-ticket"> + <section id="krb5-get-credentials-get-an-additional-ticket"> <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> -<dl class="function"> -<dt id="c.krb5_get_credentials"> -<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_get_credentials</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> context</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> out_creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_credentials"> +<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_get_credentials</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_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">options</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_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_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_get_credentials" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<table class="docutils field-list" frame="void" rules="none"> -<col class="field-name" /> -<col class="field-body" /> -<tbody valign="top"> -<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> +<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>[in]</strong> <strong>options</strong> - Options</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>in_creds</strong> - Input credentials</p> -<p class="last"><strong>[out]</strong> <strong>out_creds</strong> - Output updated credentials</p> -</td> -</tr> -</tbody> -</table> -<table class="docutils field-list" frame="void" rules="none"> -<col class="field-name" /> -<col class="field-body" /> -<tbody valign="top"> -<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>out_creds</strong> - Output updated 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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Use <em>ccache</em> or a TGS exchange to get a service ticket matching <em>in_creds</em> .</p> <p>Valid values for <em>options</em> are:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_GC_CACHED.html#KRB5_GC_CACHED" title="KRB5_GC_CACHED"><code class="xref py py-data docutils literal"><span class="pre">KRB5_GC_CACHED</span></code></a> Search only credential cache for the ticket</li> -<li><a class="reference internal" href="../macros/KRB5_GC_USER_USER.html#KRB5_GC_USER_USER" title="KRB5_GC_USER_USER"><code class="xref py py-data docutils literal"><span class="pre">KRB5_GC_USER_USER</span></code></a> Return a user to user authentication ticket</li> +<li><p>#KRB5_GC_CACHED Search only credential cache for the ticket</p></li> +<li><p>#KRB5_GC_USER_USER Return a user to user authentication ticket</p></li> </ul> </div></blockquote> <p><em>in_creds</em> must be non-null. <em>in_creds->client</em> and <em>in_creds->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->authdata</em> ; otherwise set <em>in_creds->authdata</em> to NULL. The session key type is specified in <em>in_creds->keyblock.enctype</em> , if it is nonzero.</p> </div></blockquote> <p>The expiration date is specified in <em>in_creds->times.endtime</em> . The KDC may return tickets with an earlier expiration date. If <em>in_creds->times.endtime</em> is set to 0, the latest possible expiration date will be requested.</p> <p>Any returned ticket and intermediate ticket-granting tickets are stored in <em>ccache</em> .</p> -<p>Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></code></a> to free <em>out_creds</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_creds() to free <em>out_creds</em> when it is no longer needed.</p> +</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_get_credentials - Get an additional ticket.</a></li> @@ -162,6 +147,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -169,8 +155,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> |