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 5 credential handing 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&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 5 credential handing 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:ga7335efb74572151bb521c367c39b7a4a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga7335efb74572151bb521c367c39b7a4a">krb5_fwd_tgt_creds</a> (krb5_context context, krb5_auth_context auth_context, const char *hostname, krb5_principal client, krb5_principal server, krb5_ccache ccache, int forwardable, krb5_data *out_data)</td></tr> 33<tr class="separator:ga7335efb74572151bb521c367c39b7a4a"><td class="memSeparator" colspan="2"> </td></tr> 34<tr class="memitem:ga6429a273ae5ed0d9333a22f5b5f1f42a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga6429a273ae5ed0d9333a22f5b5f1f42a">krb5_get_forwarded_creds</a> (krb5_context context, krb5_auth_context auth_context, krb5_ccache ccache, krb5_flags flags, const char *hostname, krb5_creds *in_creds, krb5_data *out_data)</td></tr> 35<tr class="separator:ga6429a273ae5ed0d9333a22f5b5f1f42a"><td class="memSeparator" colspan="2"> </td></tr> 36<tr class="memitem:gabc0922393cb5c5eecec2d83f1851c21b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gabc0922393cb5c5eecec2d83f1851c21b">krb5_get_init_creds_opt_alloc</a> (krb5_context context, krb5_get_init_creds_opt **opt)</td></tr> 37<tr class="separator:gabc0922393cb5c5eecec2d83f1851c21b"><td class="memSeparator" colspan="2"> </td></tr> 38<tr class="memitem:ga2be2f013c88153be9535c17a2b16f336"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga2be2f013c88153be9535c17a2b16f336">krb5_get_init_creds_opt_free</a> (krb5_context context, krb5_get_init_creds_opt *opt)</td></tr> 39<tr class="separator:ga2be2f013c88153be9535c17a2b16f336"><td class="memSeparator" colspan="2"> </td></tr> 40<tr class="memitem:ga1a610bb2706e4048e8220225da110033"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga1a610bb2706e4048e8220225da110033">krb5_init_creds_init</a> (krb5_context context, krb5_principal client, krb5_prompter_fct prompter, void *prompter_data, krb5_deltat start_time, krb5_get_init_creds_opt *options, krb5_init_creds_context *rctx)</td></tr> 41<tr class="separator:ga1a610bb2706e4048e8220225da110033"><td class="memSeparator" colspan="2"> </td></tr> 42<tr class="memitem:ga71f386b20c42540d4e733eeb7c0cb18e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga71f386b20c42540d4e733eeb7c0cb18e">krb5_init_creds_set_service</a> (krb5_context context, krb5_init_creds_context ctx, const char *service)</td></tr> 43<tr class="separator:ga71f386b20c42540d4e733eeb7c0cb18e"><td class="memSeparator" colspan="2"> </td></tr> 44<tr class="memitem:ga0a1d093a3c43b57b5e84206e73441d68"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga0a1d093a3c43b57b5e84206e73441d68">krb5_init_creds_set_password</a> (krb5_context context, krb5_init_creds_context ctx, const char *password)</td></tr> 45<tr class="separator:ga0a1d093a3c43b57b5e84206e73441d68"><td class="memSeparator" colspan="2"> </td></tr> 46<tr class="memitem:gab80179f38c8cc87627752d5db22c8203"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab80179f38c8cc87627752d5db22c8203">krb5_init_creds_set_keytab</a> (krb5_context context, krb5_init_creds_context ctx, krb5_keytab keytab)</td></tr> 47<tr class="separator:gab80179f38c8cc87627752d5db22c8203"><td class="memSeparator" colspan="2"> </td></tr> 48<tr class="memitem:ga9b1f54a05b9e7b60bef0c7d5f40b351b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga9b1f54a05b9e7b60bef0c7d5f40b351b">krb5_init_creds_step</a> (krb5_context context, krb5_init_creds_context ctx, krb5_data *in, krb5_data *out, krb5_krbhst_info *hostinfo, unsigned int *flags)</td></tr> 49<tr class="separator:ga9b1f54a05b9e7b60bef0c7d5f40b351b"><td class="memSeparator" colspan="2"> </td></tr> 50<tr class="memitem:gab5b9ab4698f5af99c06dbcc015c39e27"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab5b9ab4698f5af99c06dbcc015c39e27">krb5_init_creds_get_error</a> (krb5_context context, krb5_init_creds_context ctx, KRB_ERROR *error)</td></tr> 51<tr class="separator:gab5b9ab4698f5af99c06dbcc015c39e27"><td class="memSeparator" colspan="2"> </td></tr> 52<tr class="memitem:gaf878f5715a3048995f175c09e95a3a71"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gaf878f5715a3048995f175c09e95a3a71">krb5_init_creds_free</a> (krb5_context context, krb5_init_creds_context ctx)</td></tr> 53<tr class="separator:gaf878f5715a3048995f175c09e95a3a71"><td class="memSeparator" colspan="2"> </td></tr> 54<tr class="memitem:gab1716df7cb25ebea9bbf652094970bce"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab1716df7cb25ebea9bbf652094970bce">krb5_init_creds_get</a> (krb5_context context, krb5_init_creds_context ctx)</td></tr> 55<tr class="separator:gab1716df7cb25ebea9bbf652094970bce"><td class="memSeparator" colspan="2"> </td></tr> 56<tr class="memitem:gae7e4852f19e7f83bd743952491d1f4b1"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gae7e4852f19e7f83bd743952491d1f4b1">krb5_get_init_creds_password</a> (krb5_context context, krb5_creds *creds, krb5_principal client, const char *password, krb5_prompter_fct prompter, void *data, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr> 57<tr class="separator:gae7e4852f19e7f83bd743952491d1f4b1"><td class="memSeparator" colspan="2"> </td></tr> 58<tr class="memitem:ga32573c317cca5198b04550d753b369a1"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga32573c317cca5198b04550d753b369a1">krb5_get_init_creds_keyblock</a> (krb5_context context, krb5_creds *creds, krb5_principal client, krb5_keyblock *keyblock, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr> 59<tr class="separator:ga32573c317cca5198b04550d753b369a1"><td class="memSeparator" colspan="2"> </td></tr> 60<tr class="memitem:ga83e4a8a74b08522bd778c2d59ef1f2b6"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga83e4a8a74b08522bd778c2d59ef1f2b6">krb5_get_init_creds_keytab</a> (krb5_context context, krb5_creds *creds, krb5_principal client, krb5_keytab keytab, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr> 61<tr class="separator:ga83e4a8a74b08522bd778c2d59ef1f2b6"><td class="memSeparator" colspan="2"> </td></tr> 62</table> 63<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 64<h2 class="groupheader">Function Documentation</h2> 65<a id="ga7335efb74572151bb521c367c39b7a4a"></a> 66<h2 class="memtitle"><span class="permalink"><a href="#ga7335efb74572151bb521c367c39b7a4a">◆ </a></span>krb5_fwd_tgt_creds()</h2> 67 68<div class="memitem"> 69<div class="memproto"> 70 <table class="memname"> 71 <tr> 72 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_fwd_tgt_creds </td> 73 <td>(</td> 74 <td class="paramtype">krb5_context </td> 75 <td class="paramname"><em>context</em>, </td> 76 </tr> 77 <tr> 78 <td class="paramkey"></td> 79 <td></td> 80 <td class="paramtype">krb5_auth_context </td> 81 <td class="paramname"><em>auth_context</em>, </td> 82 </tr> 83 <tr> 84 <td class="paramkey"></td> 85 <td></td> 86 <td class="paramtype">const char * </td> 87 <td class="paramname"><em>hostname</em>, </td> 88 </tr> 89 <tr> 90 <td class="paramkey"></td> 91 <td></td> 92 <td class="paramtype">krb5_principal </td> 93 <td class="paramname"><em>client</em>, </td> 94 </tr> 95 <tr> 96 <td class="paramkey"></td> 97 <td></td> 98 <td class="paramtype">krb5_principal </td> 99 <td class="paramname"><em>server</em>, </td> 100 </tr> 101 <tr> 102 <td class="paramkey"></td> 103 <td></td> 104 <td class="paramtype">krb5_ccache </td> 105 <td class="paramname"><em>ccache</em>, </td> 106 </tr> 107 <tr> 108 <td class="paramkey"></td> 109 <td></td> 110 <td class="paramtype">int </td> 111 <td class="paramname"><em>forwardable</em>, </td> 112 </tr> 113 <tr> 114 <td class="paramkey"></td> 115 <td></td> 116 <td class="paramtype">krb5_data * </td> 117 <td class="paramname"><em>out_data</em> </td> 118 </tr> 119 <tr> 120 <td></td> 121 <td>)</td> 122 <td></td><td></td> 123 </tr> 124 </table> 125</div><div class="memdoc"> 126<p>Forward credentials for client to host hostname , making them forwardable if forwardable, and returning the blob of data to sent in out_data. If hostname == NULL, pick it from server.</p> 127<dl class="params"><dt>Parameters</dt><dd> 128 <table class="params"> 129 <tr><td class="paramname">context</td><td>A kerberos 5 context. </td></tr> 130 <tr><td class="paramname">auth_context</td><td>the auth context with the key to encrypt the out_data. </td></tr> 131 <tr><td class="paramname">hostname</td><td>the host to forward the tickets too. </td></tr> 132 <tr><td class="paramname">client</td><td>the client to delegate from. </td></tr> 133 <tr><td class="paramname">server</td><td>the server to delegate the credential too. </td></tr> 134 <tr><td class="paramname">ccache</td><td>credential cache to use. </td></tr> 135 <tr><td class="paramname">forwardable</td><td>make the forwarded ticket forwabledable. </td></tr> 136 <tr><td class="paramname">out_data</td><td>the resulting credential.</td></tr> 137 </table> 138 </dd> 139</dl> 140<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0. </dd></dl> 141 142</div> 143</div> 144<a id="ga6429a273ae5ed0d9333a22f5b5f1f42a"></a> 145<h2 class="memtitle"><span class="permalink"><a href="#ga6429a273ae5ed0d9333a22f5b5f1f42a">◆ </a></span>krb5_get_forwarded_creds()</h2> 146 147<div class="memitem"> 148<div class="memproto"> 149 <table class="memname"> 150 <tr> 151 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_forwarded_creds </td> 152 <td>(</td> 153 <td class="paramtype">krb5_context </td> 154 <td class="paramname"><em>context</em>, </td> 155 </tr> 156 <tr> 157 <td class="paramkey"></td> 158 <td></td> 159 <td class="paramtype">krb5_auth_context </td> 160 <td class="paramname"><em>auth_context</em>, </td> 161 </tr> 162 <tr> 163 <td class="paramkey"></td> 164 <td></td> 165 <td class="paramtype">krb5_ccache </td> 166 <td class="paramname"><em>ccache</em>, </td> 167 </tr> 168 <tr> 169 <td class="paramkey"></td> 170 <td></td> 171 <td class="paramtype">krb5_flags </td> 172 <td class="paramname"><em>flags</em>, </td> 173 </tr> 174 <tr> 175 <td class="paramkey"></td> 176 <td></td> 177 <td class="paramtype">const char * </td> 178 <td class="paramname"><em>hostname</em>, </td> 179 </tr> 180 <tr> 181 <td class="paramkey"></td> 182 <td></td> 183 <td class="paramtype">krb5_creds * </td> 184 <td class="paramname"><em>in_creds</em>, </td> 185 </tr> 186 <tr> 187 <td class="paramkey"></td> 188 <td></td> 189 <td class="paramtype">krb5_data * </td> 190 <td class="paramname"><em>out_data</em> </td> 191 </tr> 192 <tr> 193 <td></td> 194 <td>)</td> 195 <td></td><td></td> 196 </tr> 197 </table> 198</div><div class="memdoc"> 199<p>Gets tickets forwarded to hostname. If the tickets that are forwarded are address-less, the forwarded tickets will also be address-less.</p> 200<p>If the ticket have any address, hostname will be used for figure out the address to forward the ticket too. This since this might use DNS, its insecure and also doesn't represent configured all addresses of the host. For example, the host might have two adresses, one IPv4 and one IPv6 address where the later is not published in DNS. This IPv6 address might be used communications and thus the resulting ticket useless.</p> 201<dl class="params"><dt>Parameters</dt><dd> 202 <table class="params"> 203 <tr><td class="paramname">context</td><td>A kerberos 5 context. </td></tr> 204 <tr><td class="paramname">auth_context</td><td>the auth context with the key to encrypt the out_data. </td></tr> 205 <tr><td class="paramname">ccache</td><td>credential cache to use </td></tr> 206 <tr><td class="paramname">flags</td><td>the flags to control the resulting ticket flags </td></tr> 207 <tr><td class="paramname">hostname</td><td>the host to forward the tickets too. </td></tr> 208 <tr><td class="paramname">in_creds</td><td>the in client and server ticket names. The client and server components forwarded to the remote host. </td></tr> 209 <tr><td class="paramname">out_data</td><td>the resulting credential.</td></tr> 210 </table> 211 </dd> 212</dl> 213<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0. </dd></dl> 214<p>Some older of the MIT gssapi library used clear-text tickets (warped inside AP-REQ encryption), use the krb5_auth_context flag KRB5_AUTH_CONTEXT_CLEAR_FORWARDED_CRED to support those tickets. The session key is used otherwise to encrypt the forwarded ticket.</p> 215 216</div> 217</div> 218<a id="ga32573c317cca5198b04550d753b369a1"></a> 219<h2 class="memtitle"><span class="permalink"><a href="#ga32573c317cca5198b04550d753b369a1">◆ </a></span>krb5_get_init_creds_keyblock()</h2> 220 221<div class="memitem"> 222<div class="memproto"> 223 <table class="memname"> 224 <tr> 225 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_keyblock </td> 226 <td>(</td> 227 <td class="paramtype">krb5_context </td> 228 <td class="paramname"><em>context</em>, </td> 229 </tr> 230 <tr> 231 <td class="paramkey"></td> 232 <td></td> 233 <td class="paramtype">krb5_creds * </td> 234 <td class="paramname"><em>creds</em>, </td> 235 </tr> 236 <tr> 237 <td class="paramkey"></td> 238 <td></td> 239 <td class="paramtype">krb5_principal </td> 240 <td class="paramname"><em>client</em>, </td> 241 </tr> 242 <tr> 243 <td class="paramkey"></td> 244 <td></td> 245 <td class="paramtype">krb5_keyblock * </td> 246 <td class="paramname"><em>keyblock</em>, </td> 247 </tr> 248 <tr> 249 <td class="paramkey"></td> 250 <td></td> 251 <td class="paramtype">krb5_deltat </td> 252 <td class="paramname"><em>start_time</em>, </td> 253 </tr> 254 <tr> 255 <td class="paramkey"></td> 256 <td></td> 257 <td class="paramtype">const char * </td> 258 <td class="paramname"><em>in_tkt_service</em>, </td> 259 </tr> 260 <tr> 261 <td class="paramkey"></td> 262 <td></td> 263 <td class="paramtype">krb5_get_init_creds_opt * </td> 264 <td class="paramname"><em>options</em> </td> 265 </tr> 266 <tr> 267 <td></td> 268 <td>)</td> 269 <td></td><td></td> 270 </tr> 271 </table> 272</div><div class="memdoc"> 273<p>Get new credentials using keyblock. </p> 274 275</div> 276</div> 277<a id="ga83e4a8a74b08522bd778c2d59ef1f2b6"></a> 278<h2 class="memtitle"><span class="permalink"><a href="#ga83e4a8a74b08522bd778c2d59ef1f2b6">◆ </a></span>krb5_get_init_creds_keytab()</h2> 279 280<div class="memitem"> 281<div class="memproto"> 282 <table class="memname"> 283 <tr> 284 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_keytab </td> 285 <td>(</td> 286 <td class="paramtype">krb5_context </td> 287 <td class="paramname"><em>context</em>, </td> 288 </tr> 289 <tr> 290 <td class="paramkey"></td> 291 <td></td> 292 <td class="paramtype">krb5_creds * </td> 293 <td class="paramname"><em>creds</em>, </td> 294 </tr> 295 <tr> 296 <td class="paramkey"></td> 297 <td></td> 298 <td class="paramtype">krb5_principal </td> 299 <td class="paramname"><em>client</em>, </td> 300 </tr> 301 <tr> 302 <td class="paramkey"></td> 303 <td></td> 304 <td class="paramtype">krb5_keytab </td> 305 <td class="paramname"><em>keytab</em>, </td> 306 </tr> 307 <tr> 308 <td class="paramkey"></td> 309 <td></td> 310 <td class="paramtype">krb5_deltat </td> 311 <td class="paramname"><em>start_time</em>, </td> 312 </tr> 313 <tr> 314 <td class="paramkey"></td> 315 <td></td> 316 <td class="paramtype">const char * </td> 317 <td class="paramname"><em>in_tkt_service</em>, </td> 318 </tr> 319 <tr> 320 <td class="paramkey"></td> 321 <td></td> 322 <td class="paramtype">krb5_get_init_creds_opt * </td> 323 <td class="paramname"><em>options</em> </td> 324 </tr> 325 <tr> 326 <td></td> 327 <td>)</td> 328 <td></td><td></td> 329 </tr> 330 </table> 331</div><div class="memdoc"> 332<p>Get new credentials using keytab. </p> 333 334</div> 335</div> 336<a id="gabc0922393cb5c5eecec2d83f1851c21b"></a> 337<h2 class="memtitle"><span class="permalink"><a href="#gabc0922393cb5c5eecec2d83f1851c21b">◆ </a></span>krb5_get_init_creds_opt_alloc()</h2> 338 339<div class="memitem"> 340<div class="memproto"> 341 <table class="memname"> 342 <tr> 343 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_opt_alloc </td> 344 <td>(</td> 345 <td class="paramtype">krb5_context </td> 346 <td class="paramname"><em>context</em>, </td> 347 </tr> 348 <tr> 349 <td class="paramkey"></td> 350 <td></td> 351 <td class="paramtype">krb5_get_init_creds_opt ** </td> 352 <td class="paramname"><em>opt</em> </td> 353 </tr> 354 <tr> 355 <td></td> 356 <td>)</td> 357 <td></td><td></td> 358 </tr> 359 </table> 360</div><div class="memdoc"> 361<p>Allocate a new krb5_get_init_creds_opt structure, free with <a class="el" href="group__krb5__credential.html#ga2be2f013c88153be9535c17a2b16f336">krb5_get_init_creds_opt_free()</a>. </p> 362 363</div> 364</div> 365<a id="ga2be2f013c88153be9535c17a2b16f336"></a> 366<h2 class="memtitle"><span class="permalink"><a href="#ga2be2f013c88153be9535c17a2b16f336">◆ </a></span>krb5_get_init_creds_opt_free()</h2> 367 368<div class="memitem"> 369<div class="memproto"> 370 <table class="memname"> 371 <tr> 372 <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_get_init_creds_opt_free </td> 373 <td>(</td> 374 <td class="paramtype">krb5_context </td> 375 <td class="paramname"><em>context</em>, </td> 376 </tr> 377 <tr> 378 <td class="paramkey"></td> 379 <td></td> 380 <td class="paramtype">krb5_get_init_creds_opt * </td> 381 <td class="paramname"><em>opt</em> </td> 382 </tr> 383 <tr> 384 <td></td> 385 <td>)</td> 386 <td></td><td></td> 387 </tr> 388 </table> 389</div><div class="memdoc"> 390<p>Free krb5_get_init_creds_opt structure. </p> 391 392</div> 393</div> 394<a id="gae7e4852f19e7f83bd743952491d1f4b1"></a> 395<h2 class="memtitle"><span class="permalink"><a href="#gae7e4852f19e7f83bd743952491d1f4b1">◆ </a></span>krb5_get_init_creds_password()</h2> 396 397<div class="memitem"> 398<div class="memproto"> 399 <table class="memname"> 400 <tr> 401 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_password </td> 402 <td>(</td> 403 <td class="paramtype">krb5_context </td> 404 <td class="paramname"><em>context</em>, </td> 405 </tr> 406 <tr> 407 <td class="paramkey"></td> 408 <td></td> 409 <td class="paramtype">krb5_creds * </td> 410 <td class="paramname"><em>creds</em>, </td> 411 </tr> 412 <tr> 413 <td class="paramkey"></td> 414 <td></td> 415 <td class="paramtype">krb5_principal </td> 416 <td class="paramname"><em>client</em>, </td> 417 </tr> 418 <tr> 419 <td class="paramkey"></td> 420 <td></td> 421 <td class="paramtype">const char * </td> 422 <td class="paramname"><em>password</em>, </td> 423 </tr> 424 <tr> 425 <td class="paramkey"></td> 426 <td></td> 427 <td class="paramtype">krb5_prompter_fct </td> 428 <td class="paramname"><em>prompter</em>, </td> 429 </tr> 430 <tr> 431 <td class="paramkey"></td> 432 <td></td> 433 <td class="paramtype">void * </td> 434 <td class="paramname"><em>data</em>, </td> 435 </tr> 436 <tr> 437 <td class="paramkey"></td> 438 <td></td> 439 <td class="paramtype">krb5_deltat </td> 440 <td class="paramname"><em>start_time</em>, </td> 441 </tr> 442 <tr> 443 <td class="paramkey"></td> 444 <td></td> 445 <td class="paramtype">const char * </td> 446 <td class="paramname"><em>in_tkt_service</em>, </td> 447 </tr> 448 <tr> 449 <td class="paramkey"></td> 450 <td></td> 451 <td class="paramtype">krb5_get_init_creds_opt * </td> 452 <td class="paramname"><em>options</em> </td> 453 </tr> 454 <tr> 455 <td></td> 456 <td>)</td> 457 <td></td><td></td> 458 </tr> 459 </table> 460</div><div class="memdoc"> 461<p>Get new credentials using password. </p> 462 463</div> 464</div> 465<a id="gaf878f5715a3048995f175c09e95a3a71"></a> 466<h2 class="memtitle"><span class="permalink"><a href="#gaf878f5715a3048995f175c09e95a3a71">◆ </a></span>krb5_init_creds_free()</h2> 467 468<div class="memitem"> 469<div class="memproto"> 470 <table class="memname"> 471 <tr> 472 <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_creds_free </td> 473 <td>(</td> 474 <td class="paramtype">krb5_context </td> 475 <td class="paramname"><em>context</em>, </td> 476 </tr> 477 <tr> 478 <td class="paramkey"></td> 479 <td></td> 480 <td class="paramtype">krb5_init_creds_context </td> 481 <td class="paramname"><em>ctx</em> </td> 482 </tr> 483 <tr> 484 <td></td> 485 <td>)</td> 486 <td></td><td></td> 487 </tr> 488 </table> 489</div><div class="memdoc"> 490<p>Free the krb5_init_creds_context allocated by <a class="el" href="group__krb5__credential.html#ga1a610bb2706e4048e8220225da110033">krb5_init_creds_init()</a>.</p> 491<dl class="params"><dt>Parameters</dt><dd> 492 <table class="params"> 493 <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> 494 <tr><td class="paramname">ctx</td><td>The krb5_init_creds_context to free. </td></tr> 495 </table> 496 </dd> 497</dl> 498 499</div> 500</div> 501<a id="gab1716df7cb25ebea9bbf652094970bce"></a> 502<h2 class="memtitle"><span class="permalink"><a href="#gab1716df7cb25ebea9bbf652094970bce">◆ </a></span>krb5_init_creds_get()</h2> 503 504<div class="memitem"> 505<div class="memproto"> 506 <table class="memname"> 507 <tr> 508 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get </td> 509 <td>(</td> 510 <td class="paramtype">krb5_context </td> 511 <td class="paramname"><em>context</em>, </td> 512 </tr> 513 <tr> 514 <td class="paramkey"></td> 515 <td></td> 516 <td class="paramtype">krb5_init_creds_context </td> 517 <td class="paramname"><em>ctx</em> </td> 518 </tr> 519 <tr> 520 <td></td> 521 <td>)</td> 522 <td></td><td></td> 523 </tr> 524 </table> 525</div><div class="memdoc"> 526<p>Get new credentials as setup by the krb5_init_creds_context.</p> 527<dl class="params"><dt>Parameters</dt><dd> 528 <table class="params"> 529 <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> 530 <tr><td class="paramname">ctx</td><td>The krb5_init_creds_context to process. </td></tr> 531 </table> 532 </dd> 533</dl> 534 535</div> 536</div> 537<a id="gab5b9ab4698f5af99c06dbcc015c39e27"></a> 538<h2 class="memtitle"><span class="permalink"><a href="#gab5b9ab4698f5af99c06dbcc015c39e27">◆ </a></span>krb5_init_creds_get_error()</h2> 539 540<div class="memitem"> 541<div class="memproto"> 542 <table class="memname"> 543 <tr> 544 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get_error </td> 545 <td>(</td> 546 <td class="paramtype">krb5_context </td> 547 <td class="paramname"><em>context</em>, </td> 548 </tr> 549 <tr> 550 <td class="paramkey"></td> 551 <td></td> 552 <td class="paramtype">krb5_init_creds_context </td> 553 <td class="paramname"><em>ctx</em>, </td> 554 </tr> 555 <tr> 556 <td class="paramkey"></td> 557 <td></td> 558 <td class="paramtype">KRB_ERROR * </td> 559 <td class="paramname"><em>error</em> </td> 560 </tr> 561 <tr> 562 <td></td> 563 <td>)</td> 564 <td></td><td></td> 565 </tr> 566 </table> 567</div><div class="memdoc"> 568<p>Get the last error from the transaction.</p> 569<dl class="section return"><dt>Returns</dt><dd>Returns 0 or an error code </dd></dl> 570 571</div> 572</div> 573<a id="ga1a610bb2706e4048e8220225da110033"></a> 574<h2 class="memtitle"><span class="permalink"><a href="#ga1a610bb2706e4048e8220225da110033">◆ </a></span>krb5_init_creds_init()</h2> 575 576<div class="memitem"> 577<div class="memproto"> 578 <table class="memname"> 579 <tr> 580 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_init </td> 581 <td>(</td> 582 <td class="paramtype">krb5_context </td> 583 <td class="paramname"><em>context</em>, </td> 584 </tr> 585 <tr> 586 <td class="paramkey"></td> 587 <td></td> 588 <td class="paramtype">krb5_principal </td> 589 <td class="paramname"><em>client</em>, </td> 590 </tr> 591 <tr> 592 <td class="paramkey"></td> 593 <td></td> 594 <td class="paramtype">krb5_prompter_fct </td> 595 <td class="paramname"><em>prompter</em>, </td> 596 </tr> 597 <tr> 598 <td class="paramkey"></td> 599 <td></td> 600 <td class="paramtype">void * </td> 601 <td class="paramname"><em>prompter_data</em>, </td> 602 </tr> 603 <tr> 604 <td class="paramkey"></td> 605 <td></td> 606 <td class="paramtype">krb5_deltat </td> 607 <td class="paramname"><em>start_time</em>, </td> 608 </tr> 609 <tr> 610 <td class="paramkey"></td> 611 <td></td> 612 <td class="paramtype">krb5_get_init_creds_opt * </td> 613 <td class="paramname"><em>options</em>, </td> 614 </tr> 615 <tr> 616 <td class="paramkey"></td> 617 <td></td> 618 <td class="paramtype">krb5_init_creds_context * </td> 619 <td class="paramname"><em>rctx</em> </td> 620 </tr> 621 <tr> 622 <td></td> 623 <td>)</td> 624 <td></td><td></td> 625 </tr> 626 </table> 627</div><div class="memdoc"> 628<p>Start a new context to get a new initial credential.</p> 629<dl class="params"><dt>Parameters</dt><dd> 630 <table class="params"> 631 <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> 632 <tr><td class="paramname">client</td><td>The Kerberos principal to get the credential for, if NULL is given, the default principal is used as determined by krb5_get_default_principal(). </td></tr> 633 <tr><td class="paramname">prompter</td><td></td></tr> 634 <tr><td class="paramname">prompter_data</td><td></td></tr> 635 <tr><td class="paramname">start_time</td><td>the time the ticket should start to be valid or 0 for now. </td></tr> 636 <tr><td class="paramname">options</td><td>a options structure, can be NULL for default options. </td></tr> 637 <tr><td class="paramname">rctx</td><td>A new allocated free with <a class="el" href="group__krb5__credential.html#gaf878f5715a3048995f175c09e95a3a71">krb5_init_creds_free()</a>.</td></tr> 638 </table> 639 </dd> 640</dl> 641<dl class="section return"><dt>Returns</dt><dd>0 for success or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> 642 643</div> 644</div> 645<a id="gab80179f38c8cc87627752d5db22c8203"></a> 646<h2 class="memtitle"><span class="permalink"><a href="#gab80179f38c8cc87627752d5db22c8203">◆ </a></span>krb5_init_creds_set_keytab()</h2> 647 648<div class="memitem"> 649<div class="memproto"> 650 <table class="memname"> 651 <tr> 652 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_keytab </td> 653 <td>(</td> 654 <td class="paramtype">krb5_context </td> 655 <td class="paramname"><em>context</em>, </td> 656 </tr> 657 <tr> 658 <td class="paramkey"></td> 659 <td></td> 660 <td class="paramtype">krb5_init_creds_context </td> 661 <td class="paramname"><em>ctx</em>, </td> 662 </tr> 663 <tr> 664 <td class="paramkey"></td> 665 <td></td> 666 <td class="paramtype">krb5_keytab </td> 667 <td class="paramname"><em>keytab</em> </td> 668 </tr> 669 <tr> 670 <td></td> 671 <td>)</td> 672 <td></td><td></td> 673 </tr> 674 </table> 675</div><div class="memdoc"> 676<p>Set the keytab to use for authentication.</p> 677<dl class="params"><dt>Parameters</dt><dd> 678 <table class="params"> 679 <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr> 680 <tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr> 681 <tr><td class="paramname">keytab</td><td>the keytab to read the key from.</td></tr> 682 </table> 683 </dd> 684</dl> 685<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> 686 687</div> 688</div> 689<a id="ga0a1d093a3c43b57b5e84206e73441d68"></a> 690<h2 class="memtitle"><span class="permalink"><a href="#ga0a1d093a3c43b57b5e84206e73441d68">◆ </a></span>krb5_init_creds_set_password()</h2> 691 692<div class="memitem"> 693<div class="memproto"> 694 <table class="memname"> 695 <tr> 696 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_password </td> 697 <td>(</td> 698 <td class="paramtype">krb5_context </td> 699 <td class="paramname"><em>context</em>, </td> 700 </tr> 701 <tr> 702 <td class="paramkey"></td> 703 <td></td> 704 <td class="paramtype">krb5_init_creds_context </td> 705 <td class="paramname"><em>ctx</em>, </td> 706 </tr> 707 <tr> 708 <td class="paramkey"></td> 709 <td></td> 710 <td class="paramtype">const char * </td> 711 <td class="paramname"><em>password</em> </td> 712 </tr> 713 <tr> 714 <td></td> 715 <td>)</td> 716 <td></td><td></td> 717 </tr> 718 </table> 719</div><div class="memdoc"> 720<p>Sets the password that will use for the request.</p> 721<dl class="params"><dt>Parameters</dt><dd> 722 <table class="params"> 723 <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr> 724 <tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr> 725 <tr><td class="paramname">password</td><td>the password to use.</td></tr> 726 </table> 727 </dd> 728</dl> 729<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> 730 731</div> 732</div> 733<a id="ga71f386b20c42540d4e733eeb7c0cb18e"></a> 734<h2 class="memtitle"><span class="permalink"><a href="#ga71f386b20c42540d4e733eeb7c0cb18e">◆ </a></span>krb5_init_creds_set_service()</h2> 735 736<div class="memitem"> 737<div class="memproto"> 738 <table class="memname"> 739 <tr> 740 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_service </td> 741 <td>(</td> 742 <td class="paramtype">krb5_context </td> 743 <td class="paramname"><em>context</em>, </td> 744 </tr> 745 <tr> 746 <td class="paramkey"></td> 747 <td></td> 748 <td class="paramtype">krb5_init_creds_context </td> 749 <td class="paramname"><em>ctx</em>, </td> 750 </tr> 751 <tr> 752 <td class="paramkey"></td> 753 <td></td> 754 <td class="paramtype">const char * </td> 755 <td class="paramname"><em>service</em> </td> 756 </tr> 757 <tr> 758 <td></td> 759 <td>)</td> 760 <td></td><td></td> 761 </tr> 762 </table> 763</div><div class="memdoc"> 764<p>Sets the service that the is requested. This call is only neede for special initial tickets, by default the a krbtgt is fetched in the default realm.</p> 765<dl class="params"><dt>Parameters</dt><dd> 766 <table class="params"> 767 <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr> 768 <tr><td class="paramname">ctx</td><td>a krb5_init_creds_context context. </td></tr> 769 <tr><td class="paramname">service</td><td>the service given as a string, for example "kadmind/admin". If NULL, the default krbtgt in the clients realm is set.</td></tr> 770 </table> 771 </dd> 772</dl> 773<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> 774 775</div> 776</div> 777<a id="ga9b1f54a05b9e7b60bef0c7d5f40b351b"></a> 778<h2 class="memtitle"><span class="permalink"><a href="#ga9b1f54a05b9e7b60bef0c7d5f40b351b">◆ </a></span>krb5_init_creds_step()</h2> 779 780<div class="memitem"> 781<div class="memproto"> 782 <table class="memname"> 783 <tr> 784 <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_step </td> 785 <td>(</td> 786 <td class="paramtype">krb5_context </td> 787 <td class="paramname"><em>context</em>, </td> 788 </tr> 789 <tr> 790 <td class="paramkey"></td> 791 <td></td> 792 <td class="paramtype">krb5_init_creds_context </td> 793 <td class="paramname"><em>ctx</em>, </td> 794 </tr> 795 <tr> 796 <td class="paramkey"></td> 797 <td></td> 798 <td class="paramtype">krb5_data * </td> 799 <td class="paramname"><em>in</em>, </td> 800 </tr> 801 <tr> 802 <td class="paramkey"></td> 803 <td></td> 804 <td class="paramtype">krb5_data * </td> 805 <td class="paramname"><em>out</em>, </td> 806 </tr> 807 <tr> 808 <td class="paramkey"></td> 809 <td></td> 810 <td class="paramtype">krb5_krbhst_info * </td> 811 <td class="paramname"><em>hostinfo</em>, </td> 812 </tr> 813 <tr> 814 <td class="paramkey"></td> 815 <td></td> 816 <td class="paramtype">unsigned int * </td> 817 <td class="paramname"><em>flags</em> </td> 818 </tr> 819 <tr> 820 <td></td> 821 <td>)</td> 822 <td></td><td></td> 823 </tr> 824 </table> 825</div><div class="memdoc"> 826<p>The core loop if krb5_get_init_creds() function family. Create the packets and have the caller send them off to the KDC.</p> 827<p>If the caller want all work been done for them, use <a class="el" href="group__krb5__credential.html#gab1716df7cb25ebea9bbf652094970bce">krb5_init_creds_get()</a> instead.</p> 828<dl class="params"><dt>Parameters</dt><dd> 829 <table class="params"> 830 <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr> 831 <tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr> 832 <tr><td class="paramname">in</td><td>input data from KDC, first round it should be reset by krb5_data_zer(). </td></tr> 833 <tr><td class="paramname">out</td><td>reply to KDC. </td></tr> 834 <tr><td class="paramname">hostinfo</td><td>KDC address info, first round it can be NULL. </td></tr> 835 <tr><td class="paramname">flags</td><td>status of the round, if KRB5_INIT_CREDS_STEP_FLAG_CONTINUE is set, continue one more round.</td></tr> 836 </table> 837 </dd> 838</dl> 839<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> 840 841</div> 842</div> 843</div><!-- contents --> 844<hr size="1"><address style="text-align: right;"><small> 845Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> 846</body> 847</html> 848
