xref: /netbsd-src/crypto/external/bsd/heimdal/dist/doc/doxyout/krb5/html/group__krb5__v4compat.html (revision dd75ac5b443e967e26b4d18cc8cd5eb98512bfbf)
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>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.9.1 -->
12<script type="text/javascript" src="menudata.js"></script>
13<script type="text/javascript" src="menu.js"></script>
14<script type="text/javascript">
15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
16$(function() {
17  initMenu('',false,false,'search.php','Search');
18});
19/* @license-end */</script>
20<div id="main-nav"></div>
21</div><!-- top -->
22<div class="header">
23  <div class="summary">
24<a href="#func-members">Functions</a>  </div>
25  <div class="headertitle">
26<div class="title">Heimdal Kerberos 4 compatiblity functions</div>  </div>
27</div><!--header-->
28<div class="contents">
29<table class="memberdecls">
30<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
31Functions</h2></td></tr>
32<tr class="memitem:ga0b661217785509322350a73e516ebb3e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__v4compat.html#ga0b661217785509322350a73e516ebb3e">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>
33<tr class="separator:ga0b661217785509322350a73e516ebb3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
34<tr class="memitem:ga9669ba06773974372902df45a8284cf0"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__v4compat.html#ga9669ba06773974372902df45a8284cf0">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>
35<tr class="separator:ga9669ba06773974372902df45a8284cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
36</table>
37<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
38<h2 class="groupheader">Function Documentation</h2>
39<a id="ga0b661217785509322350a73e516ebb3e"></a>
40<h2 class="memtitle"><span class="permalink"><a href="#ga0b661217785509322350a73e516ebb3e">&#9670;&nbsp;</a></span>krb524_convert_creds_kdc()</h2>
41
42<div class="memitem">
43<div class="memproto">
44      <table class="memname">
45        <tr>
46          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc </td>
47          <td>(</td>
48          <td class="paramtype">krb5_context&#160;</td>
49          <td class="paramname"><em>context</em>, </td>
50        </tr>
51        <tr>
52          <td class="paramkey"></td>
53          <td></td>
54          <td class="paramtype">krb5_creds *&#160;</td>
55          <td class="paramname"><em>in_cred</em>, </td>
56        </tr>
57        <tr>
58          <td class="paramkey"></td>
59          <td></td>
60          <td class="paramtype">struct credentials *&#160;</td>
61          <td class="paramname"><em>v4creds</em>&#160;</td>
62        </tr>
63        <tr>
64          <td></td>
65          <td>)</td>
66          <td></td><td></td>
67        </tr>
68      </table>
69</div><div class="memdoc">
70<p>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 &lsquo;in_cred&rsquo; doesn't contain a DES session key, then a new one is gotten from the KDC and stored in the cred cache &lsquo;ccache&rsquo;.</p>
71<dl class="params"><dt>Parameters</dt><dd>
72  <table class="params">
73    <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr>
74    <tr><td class="paramname">in_cred</td><td>the credential to convert </td></tr>
75    <tr><td class="paramname">v4creds</td><td>the converted credential</td></tr>
76  </table>
77  </dd>
78</dl>
79<dl class="section return"><dt>Returns</dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
80
81</div>
82</div>
83<a id="ga9669ba06773974372902df45a8284cf0"></a>
84<h2 class="memtitle"><span class="permalink"><a href="#ga9669ba06773974372902df45a8284cf0">&#9670;&nbsp;</a></span>krb524_convert_creds_kdc_ccache()</h2>
85
86<div class="memitem">
87<div class="memproto">
88      <table class="memname">
89        <tr>
90          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb524_convert_creds_kdc_ccache </td>
91          <td>(</td>
92          <td class="paramtype">krb5_context&#160;</td>
93          <td class="paramname"><em>context</em>, </td>
94        </tr>
95        <tr>
96          <td class="paramkey"></td>
97          <td></td>
98          <td class="paramtype">krb5_ccache&#160;</td>
99          <td class="paramname"><em>ccache</em>, </td>
100        </tr>
101        <tr>
102          <td class="paramkey"></td>
103          <td></td>
104          <td class="paramtype">krb5_creds *&#160;</td>
105          <td class="paramname"><em>in_cred</em>, </td>
106        </tr>
107        <tr>
108          <td class="paramkey"></td>
109          <td></td>
110          <td class="paramtype">struct credentials *&#160;</td>
111          <td class="paramname"><em>v4creds</em>&#160;</td>
112        </tr>
113        <tr>
114          <td></td>
115          <td>)</td>
116          <td></td><td></td>
117        </tr>
118      </table>
119</div><div class="memdoc">
120<p>Convert the v5 credentials in in_cred to v4-dito in v4creds, check the credential cache ccache before checking with the KDC.</p>
121<dl class="params"><dt>Parameters</dt><dd>
122  <table class="params">
123    <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr>
124    <tr><td class="paramname">ccache</td><td>credential cache used to check for des-ticket. </td></tr>
125    <tr><td class="paramname">in_cred</td><td>the credential to convert </td></tr>
126    <tr><td class="paramname">v4creds</td><td>the converted credential</td></tr>
127  </table>
128  </dd>
129</dl>
130<dl class="section return"><dt>Returns</dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
131
132</div>
133</div>
134</div><!-- contents -->
135<hr size="1"><address style="text-align: right;"><small>
136Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
137</body>
138</html>
139