doc/html/appdev/refs/api/krb5_cc_retrieve_cred.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_cc_retrieve_cred - Retrieve a specified credentials from a credential cache. &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.2',
  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_cc_select - Select a credential cache to use with a server principal." href="krb5_cc_select.html" />
  32     <link rel="prev" title="krb5_cc_remove_cred - Remove credentials from a credential cache." href="krb5_cc_remove_cred.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_cc_remove_cred.html" title="krb5_cc_remove_cred - Remove credentials from a credential cache."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_cc_select.html" title="krb5_cc_select - Select a credential cache to use with a server principal."
  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_cc_retrieve_cred -  Retrieve a specified credentials from a credential cache.">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-cc-retrieve-cred-retrieve-a-specified-credentials-from-a-credential-cache">
  67 <h1>krb5_cc_retrieve_cred -  Retrieve a specified credentials from a credential cache.<a class="headerlink" href="#krb5-cc-retrieve-cred-retrieve-a-specified-credentials-from-a-credential-cache" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_cc_retrieve_cred">
  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_cc_retrieve_cred</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;cache</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em>&nbsp;flags</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em>&nbsp;mcreds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em>&nbsp;creds</em><big>)</big><a class="headerlink" href="#c.krb5_cc_retrieve_cred" 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>cache</strong> - Credential cache handle</p>
  79 <p><strong>[in]</strong> <strong>flags</strong> - Flags bit mask</p>
  80 <p><strong>[in]</strong> <strong>mcreds</strong> - Credentials to match</p>
  81 <p class="last"><strong>[out]</strong> <strong>creds</strong> - Credentials matching the requested value</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 searches a credential cache for credentials matching <em>mcreds</em> and returns it if found.</p>
  98 <p>Valid values for <em>flags</em> are:</p>
  99 <blockquote>
 100 <div><blockquote>
 101 <div><ul class="simple">
 102 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_TIMES.html#KRB5_TC_MATCH_TIMES" title="KRB5_TC_MATCH_TIMES"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_TIMES</span></tt></a> The requested lifetime must be at least as great as in <em>mcreds</em> .</li>
 103 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_IS_SKEY.html#KRB5_TC_MATCH_IS_SKEY" title="KRB5_TC_MATCH_IS_SKEY"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_IS_SKEY</span></tt></a> The <em>is_skey</em> field much match exactly.</li>
 104 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_FLAGS.html#KRB5_TC_MATCH_FLAGS" title="KRB5_TC_MATCH_FLAGS"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_FLAGS</span></tt></a> Flags set in <em>mcreds</em> must be set.</li>
 105 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_TIMES_EXACT.html#KRB5_TC_MATCH_TIMES_EXACT" title="KRB5_TC_MATCH_TIMES_EXACT"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_TIMES_EXACT</span></tt></a> The requested lifetime must match exactly.</li>
 106 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_FLAGS_EXACT.html#KRB5_TC_MATCH_FLAGS_EXACT" title="KRB5_TC_MATCH_FLAGS_EXACT"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_FLAGS_EXACT</span></tt></a> Flags must match exactly.</li>
 107 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_AUTHDATA.html#KRB5_TC_MATCH_AUTHDATA" title="KRB5_TC_MATCH_AUTHDATA"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_AUTHDATA</span></tt></a> The authorization data must match.</li>
 108 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_SRV_NAMEONLY.html#KRB5_TC_MATCH_SRV_NAMEONLY" title="KRB5_TC_MATCH_SRV_NAMEONLY"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_SRV_NAMEONLY</span></tt></a> Only the name portion of the principal name must match, not the realm.</li>
 109 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_2ND_TKT.html#KRB5_TC_MATCH_2ND_TKT" title="KRB5_TC_MATCH_2ND_TKT"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_2ND_TKT</span></tt></a> The second tickets must match.</li>
 110 <li><a class="reference internal" href="../macros/KRB5_TC_MATCH_KTYPE.html#KRB5_TC_MATCH_KTYPE" title="KRB5_TC_MATCH_KTYPE"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_KTYPE</span></tt></a> The encryption key types must match.</li>
 111 <li><a class="reference internal" href="../macros/KRB5_TC_SUPPORTED_KTYPES.html#KRB5_TC_SUPPORTED_KTYPES" title="KRB5_TC_SUPPORTED_KTYPES"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_TC_SUPPORTED_KTYPES</span></tt></a> Check all matching entries that have any supported encryption type and return the one with the encryption type listed earliest.</li>
 112 </ul>
 113 </div></blockquote>
 114 <p>Use <a class="reference internal" href="krb5_free_cred_contents.html#c.krb5_free_cred_contents" title="krb5_free_cred_contents"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_cred_contents()</span></tt></a> to free <em>creds</em> when it is no longer needed.</p>
 115 </div></blockquote>
 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_cc_retrieve_cred -  Retrieve a specified credentials from a credential cache.</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.2</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_cc_remove_cred.html" title="krb5_cc_remove_cred - Remove credentials from a credential cache."
 181             >previous</a> |
 182         <a href="krb5_cc_select.html" title="krb5_cc_select - Select a credential cache to use with a server principal."
 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_cc_retrieve_cred -  Retrieve a specified credentials from a credential cache.">feedback</a>
 189             </div>
 190         </div>
 191     </div>
 192
 193   </body>
 194 </html>