doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_in_ccache.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_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options. &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_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options." href="krb5_get_init_creds_opt_set_out_ccache.html" />
  32     <link rel="prev" title="krb5_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options." href="krb5_get_init_creds_opt_set_forwardable.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_init_creds_opt_set_forwardable.html" title="krb5_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_get_init_creds_opt_set_out_ccache.html" title="krb5_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options."
  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_init_creds_opt_set_in_ccache -  Set an input credential cache in initial credential options.">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-init-creds-opt-set-in-ccache-set-an-input-credential-cache-in-initial-credential-options">
  67 <h1>krb5_get_init_creds_opt_set_in_ccache -  Set an input credential cache in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-in-ccache-set-an-input-credential-cache-in-initial-credential-options" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_get_init_creds_opt_set_in_ccache">
  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_init_creds_opt_set_in_ccache</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_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em>&nbsp;opt</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em>&nbsp;ccache</em><big>)</big><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_in_ccache" 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>opt</strong> - Options</p>
  79 <p class="last"><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p>
  80 </td>
  81 </tr>
  82 </tbody>
  83 </table>
  84 <p>If an input credential cache is set, then the krb5_get_init_creds family of APIs will read settings from it. Setting an input ccache is desirable when the application wishes to perform authentication in the same way (using the same preauthentication mechanisms, and making the same non-security- sensitive choices) as the previous authentication attempt, which stored information in the passed-in ccache.</p>
  85 <div class="admonition note">
  86 <p class="first admonition-title">Note</p>
  87 <p class="last">New in 1.11</p>
  88 </div>
  89 </div>
  90
  91
  92           </div>
  93         </div>
  94       </div>
  95         </div>
  96         <div class="sidebar">
  97     <h2>On this page</h2>
  98     <ul>
  99 <li><a class="reference internal" href="#">krb5_get_init_creds_opt_set_in_ccache -  Set an input credential cache in initial credential options.</a></li>
 100 </ul>
 101
 102     <br/>
 103     <h2>Table of contents</h2>
 104     <ul class="current">
 105 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 106 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 107 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 108 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 109 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 110 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 111 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 112 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 113 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 114 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 115 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 116 </ul>
 117 </li>
 118 </ul>
 119 </li>
 120 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 121 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 123 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 124 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 125 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 126 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 127 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 128 </ul>
 129
 130     <br/>
 131     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 132     <h4>Search</h4>
 133     <form class="search" action="../../../search.html" method="get">
 134       <input type="text" name="q" size="18" />
 135       <input type="submit" value="Go" />
 136       <input type="hidden" name="check_keywords" value="yes" />
 137       <input type="hidden" name="area" value="default" />
 138     </form>
 139         </div>
 140         <div class="clearer"></div>
 141       </div>
 142     </div>
 143
 144     <div class="footer-wrapper">
 145         <div class="footer" >
 146             <div class="right" ><i>Release: 1.15.1</i><br />
 147                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 148             </div>
 149             <div class="left">
 150
 151         <a href="../../../index.html" title="Full Table of Contents"
 152             >Contents</a> |
 153         <a href="krb5_get_init_creds_opt_set_forwardable.html" title="krb5_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options."
 154             >previous</a> |
 155         <a href="krb5_get_init_creds_opt_set_out_ccache.html" title="krb5_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options."
 156             >next</a> |
 157         <a href="../../../genindex.html" title="General Index"
 158             >index</a> |
 159         <a href="../../../search.html" title="Enter search criteria"
 160             >Search</a> |
 161     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_get_init_creds_opt_set_in_ccache -  Set an input credential cache in initial credential options.">feedback</a>
 162             </div>
 163         </div>
 164     </div>
 165
 166   </body>
 167 </html>