crypto/heimdal/doc/doxyout/krb5/html/group__krb5__v4compat.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>HeimdalKerberos5library: Heimdal Kerberos 4 compatiblity functions</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <p>
   8 <a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
   9 </p>
  10 <!-- end of header marker -->
  11 <!-- Generated by Doxygen 1.5.6 -->
  12 <div class="navigation" id="top">
  13   <div class="tabs">
  14     <ul>
  15       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  16       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  17       <li><a href="modules.html"><span>Modules</span></a></li>
  18       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  19     </ul>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>Heimdal Kerberos 4 compatiblity functions</h1><table border="0" cellpadding="0" cellspacing="0">
  24 <tr><td></td></tr>
  25 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
  27 krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__v4compat.html#g0b661217785509322350a73e516ebb3e">krb524_convert_creds_kdc</a> (krb5_context context, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION(&quot;Use X instead&quot;)</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
  30 krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__v4compat.html#g9669ba06773974372902df45a8284cf0">krb524_convert_creds_kdc_ccache</a> (krb5_context context, krb5_ccache ccache, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION(&quot;Use X instead&quot;)</td></tr>
  31
  32 </table>
  33 <hr><a name="_details"></a><h2>Detailed Description</h2>
  34 <hr><h2>Function Documentation</h2>
  35 <a class="anchor" name="g0b661217785509322350a73e516ebb3e"></a><!-- doxytag: member="convert_creds.c::krb524_convert_creds_kdc" ref="g0b661217785509322350a73e516ebb3e" args="(krb5_context context, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION(&quot;Use X instead&quot;)" -->
  36 <div class="memitem">
  37 <div class="memproto">
  38       <table class="memname">
  39         <tr>
  40           <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc           </td>
  41           <td>(</td>
  42           <td class="paramtype">krb5_context&nbsp;</td>
  43           <td class="paramname"> <em>context</em>, </td>
  44         </tr>
  45         <tr>
  46           <td class="paramkey"></td>
  47           <td></td>
  48           <td class="paramtype">krb5_creds *&nbsp;</td>
  49           <td class="paramname"> <em>in_cred</em>, </td>
  50         </tr>
  51         <tr>
  52           <td class="paramkey"></td>
  53           <td></td>
  54           <td class="paramtype">struct credentials *&nbsp;</td>
  55           <td class="paramname"> <em>v4creds</em></td><td>&nbsp;</td>
  56         </tr>
  57         <tr>
  58           <td></td>
  59           <td>)</td>
  60           <td></td><td></td><td></td>
  61         </tr>
  62       </table>
  63 </div>
  64 <div class="memdoc">
  65
  66 <p>
  67 Convert the v5 credentials in in_cred to v4-dito in v4creds. This is done by sending them to the 524 function in the KDC. If `in_cred' doesn't contain a DES session key, then a new one is gotten from the KDC and stored in the cred cache `ccache'.<p>
  68 <dl compact><dt><b>Parameters:</b></dt><dd>
  69   <table border="0" cellspacing="2" cellpadding="0">
  70     <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>Kerberos 5 context. </td></tr>
  71     <tr><td valign="top"></td><td valign="top"><em>in_cred</em>&nbsp;</td><td>the credential to convert </td></tr>
  72     <tr><td valign="top"></td><td valign="top"><em>v4creds</em>&nbsp;</td><td>the converted credential</td></tr>
  73   </table>
  74 </dl>
  75 <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). </dd></dl>
  76
  77 </div>
  78 </div><p>
  79 <a class="anchor" name="g9669ba06773974372902df45a8284cf0"></a><!-- doxytag: member="convert_creds.c::krb524_convert_creds_kdc_ccache" ref="g9669ba06773974372902df45a8284cf0" args="(krb5_context context, krb5_ccache ccache, krb5_creds *in_cred, struct credentials *v4creds) KRB5_DEPRECATED_FUNCTION(&quot;Use X instead&quot;)" -->
  80 <div class="memitem">
  81 <div class="memproto">
  82       <table class="memname">
  83         <tr>
  84           <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc_ccache           </td>
  85           <td>(</td>
  86           <td class="paramtype">krb5_context&nbsp;</td>
  87           <td class="paramname"> <em>context</em>, </td>
  88         </tr>
  89         <tr>
  90           <td class="paramkey"></td>
  91           <td></td>
  92           <td class="paramtype">krb5_ccache&nbsp;</td>
  93           <td class="paramname"> <em>ccache</em>, </td>
  94         </tr>
  95         <tr>
  96           <td class="paramkey"></td>
  97           <td></td>
  98           <td class="paramtype">krb5_creds *&nbsp;</td>
  99           <td class="paramname"> <em>in_cred</em>, </td>
 100         </tr>
 101         <tr>
 102           <td class="paramkey"></td>
 103           <td></td>
 104           <td class="paramtype">struct credentials *&nbsp;</td>
 105           <td class="paramname"> <em>v4creds</em></td><td>&nbsp;</td>
 106         </tr>
 107         <tr>
 108           <td></td>
 109           <td>)</td>
 110           <td></td><td></td><td></td>
 111         </tr>
 112       </table>
 113 </div>
 114 <div class="memdoc">
 115
 116 <p>
 117 Convert the v5 credentials in in_cred to v4-dito in v4creds, check the credential cache ccache before checking with the KDC.<p>
 118 <dl compact><dt><b>Parameters:</b></dt><dd>
 119   <table border="0" cellspacing="2" cellpadding="0">
 120     <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>Kerberos 5 context. </td></tr>
 121     <tr><td valign="top"></td><td valign="top"><em>ccache</em>&nbsp;</td><td>credential cache used to check for des-ticket. </td></tr>
 122     <tr><td valign="top"></td><td valign="top"><em>in_cred</em>&nbsp;</td><td>the credential to convert </td></tr>
 123     <tr><td valign="top"></td><td valign="top"><em>v4creds</em>&nbsp;</td><td>the converted credential</td></tr>
 124   </table>
 125 </dl>
 126 <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see krb5_get_error_message(). </dd></dl>
 127
 128 </div>
 129 </div><p>
 130 </div>
 131 <hr size="1"><address style="text-align: right;"><small>
 132 Generated on Wed Jan 11 14:07:49 2012 for HeimdalKerberos5library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
 133 </body>
 134 </html>