/usr/share/doc/libglobus-gssapi-gsi-dev/html/group__globus__gsi__gssapi__extensions.html is in libglobus-gssapi-gsi-doc 12.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>globus_gssapi_gsi: GSSAPI Extensions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">globus_gssapi_gsi
 <span id="projectnumber">12.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GSSAPI Extensions<div class="ingroups"><a class="el" href="group__globus__gsi__gssapi.html">Globus GSSAPI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>extensions
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for GSSAPI Extensions:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__globus__gsi__gssapi__extensions.png" border="0" alt="" usemap="#group____globus____gsi____gssapi____extensions"/>
<map name="group____globus____gsi____gssapi____extensions" id="group____globus____gsi____gssapi____extensions">
<area shape="rect" id="node1" href="group__globus__gsi__gssapi__extensions__delegation.html" title="Delegation Functions. " alt="" coords="386,5,477,32"/>
<area shape="rect" id="node2" href="group__globus__gsi__gssapi__buffer__set.html" title="Buffer Set Utilities. " alt="" coords="363,56,500,83"/>
<area shape="rect" id="node3" href="group__globus__gsi__gssapi.html" title="GSI Implementation Details. " alt="" coords="5,31,124,57"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__globus__gsi__gssapi__buffer__set"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__buffer__set.html">Buffer Set Utilities</a></td></tr>
<tr class="memdesc:group__globus__gsi__gssapi__buffer__set"><td class="mdescLeft"> </td><td class="mdescRight">Buffer Set Utilities. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__globus__gsi__gssapi__extensions__delegation"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions__delegation.html">Delegation</a></td></tr>
<tr class="memdesc:group__globus__gsi__gssapi__extensions__delegation"><td class="mdescLeft"> </td><td class="mdescRight">Delegation Functions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf920f2f3cc86f2a64c7f691d81ed95b8"><td class="memItemLeft" align="right" valign="top">OM_uint32 GSS_CALLCONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions.html#gaf920f2f3cc86f2a64c7f691d81ed95b8">gss_export_cred</a> (OM_uint32 *minor_status, const gss_cred_id_t cred_handle, const gss_OID desired_mech, OM_uint32 option_req, gss_buffer_t export_buffer)</td></tr>
<tr class="memdesc:gaf920f2f3cc86f2a64c7f691d81ed95b8"><td class="mdescLeft"> </td><td class="mdescRight">Export a GSSAPI credential. <a href="#gaf920f2f3cc86f2a64c7f691d81ed95b8">More...</a><br /></td></tr>
<tr class="separator:gaf920f2f3cc86f2a64c7f691d81ed95b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafb79ab1f3f84042f122aa0f2c66964ee"><td class="memItemLeft" align="right" valign="top">OM_uint32 GSS_CALLCONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions.html#gafb79ab1f3f84042f122aa0f2c66964ee">gss_import_cred</a> (OM_uint32 *minor_status, gss_cred_id_t *output_cred_handle, const gss_OID desired_mech, OM_uint32 option_req, const gss_buffer_t import_buffer, OM_uint32 time_req, OM_uint32 *time_rec)</td></tr>
<tr class="memdesc:gafb79ab1f3f84042f122aa0f2c66964ee"><td class="mdescLeft"> </td><td class="mdescRight">Import a credential. <a href="#gafb79ab1f3f84042f122aa0f2c66964ee">More...</a><br /></td></tr>
<tr class="separator:gafb79ab1f3f84042f122aa0f2c66964ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad70b3437d33791b62c366857dc6fd304"><td class="memItemLeft" align="right" valign="top">OM_uint32 GSS_CALLCONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions.html#gad70b3437d33791b62c366857dc6fd304">gss_inquire_cred_by_oid</a> (OM_uint32 *minor_status, const gss_cred_id_t cred_handle, const gss_OID desired_object, gss_buffer_set_t *data_set)</td></tr>
<tr class="memdesc:gad70b3437d33791b62c366857dc6fd304"><td class="mdescLeft"> </td><td class="mdescRight">Inquire Cred By OID. <a href="#gad70b3437d33791b62c366857dc6fd304">More...</a><br /></td></tr>
<tr class="separator:gad70b3437d33791b62c366857dc6fd304"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c073e8623a2d8cb464c970b4aa88f1b"><td class="memItemLeft" align="right" valign="top"><a id="ga2c073e8623a2d8cb464c970b4aa88f1b"></a>
OM_uint32 GSS_CALLCONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions.html#ga2c073e8623a2d8cb464c970b4aa88f1b">gss_inquire_sec_context_by_oid</a> (OM_uint32 *minor_status, const gss_ctx_id_t context_handle, const gss_OID desired_object, gss_buffer_set_t *data_set)</td></tr>
<tr class="memdesc:ga2c073e8623a2d8cb464c970b4aa88f1b"><td class="mdescLeft"> </td><td class="mdescRight">Inquire Sec Context by OID. <br /></td></tr>
<tr class="separator:ga2c073e8623a2d8cb464c970b4aa88f1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa3b3f808b0f410c099e3de2bec91affb"><td class="memItemLeft" align="right" valign="top">OM_uint32 GSS_CALLCONV </td><td class="memItemRight" valign="bottom"><a class="el" href="group__globus__gsi__gssapi__extensions.html#gaa3b3f808b0f410c099e3de2bec91affb">gss_set_sec_context_option</a> (OM_uint32 *minor_status, gss_ctx_id_t *context_handle, const gss_OID option, const gss_buffer_t value)</td></tr>
<tr class="memdesc:gaa3b3f808b0f410c099e3de2bec91affb"><td class="mdescLeft"> </td><td class="mdescRight">Set Security Context Option. <a href="#gaa3b3f808b0f410c099e3de2bec91affb">More...</a><br /></td></tr>
<tr class="separator:gaa3b3f808b0f410c099e3de2bec91affb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>extensions </p>
<p>Experimental GSSAPI routines are defined here. These may change, and we will be looking at adding these to Kerberos as mods, and submitting them to the IETF.</p>
<p>These extensions are more fully documented in <a href="http://www.ggf.org/documents/GFD.24.pdf">GSS-API Extensions</a> </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf920f2f3cc86f2a64c7f691d81ed95b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf920f2f3cc86f2a64c7f691d81ed95b8">§ </a></span>gss_export_cred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OM_uint32 GSS_CALLCONV gss_export_cred </td>
<td>(</td>
<td class="paramtype">OM_uint32 * </td>
<td class="paramname"><em>minor_status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_cred_id_t </td>
<td class="paramname"><em>cred_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_OID </td>
<td class="paramname"><em>desired_mech</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OM_uint32 </td>
<td class="paramname"><em>option_req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gss_buffer_t </td>
<td class="paramname"><em>export_buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export a GSSAPI credential. </p>
<p>Saves the credential so it can be checkpointed and imported by gss_import_cred</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">minor_status</td><td></td></tr>
<tr><td class="paramname">cred_handle</td><td></td></tr>
<tr><td class="paramname">desired_mech</td><td>Should either be gss_mech_globus_gssapi_openssl or NULL (in which case gss_mech_globus_gssapi_openssl is assumed). </td></tr>
<tr><td class="paramname">option_req</td><td></td></tr>
<tr><td class="paramname">export_buffer</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="gafb79ab1f3f84042f122aa0f2c66964ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb79ab1f3f84042f122aa0f2c66964ee">§ </a></span>gss_import_cred()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OM_uint32 GSS_CALLCONV gss_import_cred </td>
<td>(</td>
<td class="paramtype">OM_uint32 * </td>
<td class="paramname"><em>minor_status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gss_cred_id_t * </td>
<td class="paramname"><em>output_cred_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_OID </td>
<td class="paramname"><em>desired_mech</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OM_uint32 </td>
<td class="paramname"><em>option_req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_buffer_t </td>
<td class="paramname"><em>import_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OM_uint32 </td>
<td class="paramname"><em>time_req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OM_uint32 * </td>
<td class="paramname"><em>time_rec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Import a credential. </p>
<p>This function will import credentials exported by <a class="el" href="group__globus__gsi__gssapi__extensions.html#gaf920f2f3cc86f2a64c7f691d81ed95b8" title="Export a GSSAPI credential. ">gss_export_cred()</a>. It is intended to allow a multiple use application to checkpoint delegated credentials.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">minor_status</td><td>The minor status returned by this function. This parameter will be 0 upon success. </td></tr>
<tr><td class="paramname">output_cred_handle</td><td>Upon success, this parameter will contain the imported credential. When no longer needed this credential should be freed using <a class="el" href="group__globus__gsi__gssapi.html#gae99fb919e751c1071d0e80dfa5fb27b8" title="Release Credential. ">gss_release_cred()</a>. </td></tr>
<tr><td class="paramname">desired_mech</td><td>This parameter may be used to specify the desired security mechanism. May be GSS_C_NO_OID. </td></tr>
<tr><td class="paramname">option_req</td><td>This parameter indicates which option_req value was used to produce the import_buffer. </td></tr>
<tr><td class="paramname">import_buffer</td><td>A buffer produced by gss_export_credential(). </td></tr>
<tr><td class="paramname">time_req</td><td>The requested period of validity (seconds) for the imported credential. May be NULL. </td></tr>
<tr><td class="paramname">time_rec</td><td>This parameter will contain the received period of validity of the imported credential upon success. May be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GSS_S_COMPLETE</td><td>Success </td></tr>
<tr><td class="paramname">GSS_S_BAD_MECH</td><td>Requested security mechanism is unavailable </td></tr>
<tr><td class="paramname">GSS_S_DEFECTIVE_TOKEN</td><td>import_buffer is defective </td></tr>
<tr><td class="paramname">GSS_S_FAILURE</td><td>General failure </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad70b3437d33791b62c366857dc6fd304"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad70b3437d33791b62c366857dc6fd304">§ </a></span>gss_inquire_cred_by_oid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OM_uint32 GSS_CALLCONV gss_inquire_cred_by_oid </td>
<td>(</td>
<td class="paramtype">OM_uint32 * </td>
<td class="paramname"><em>minor_status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_cred_id_t </td>
<td class="paramname"><em>cred_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_OID </td>
<td class="paramname"><em>desired_object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gss_buffer_set_t * </td>
<td class="paramname"><em>data_set</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inquire Cred By OID. </p>
<p>NOTE: Checks both the cert in the credential and the certs in the cert chain for a valid extension that matches the desired OID. The first one found is used, starting with the endpoint cert, and then searching the cert chain.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">minor_status</td><td></td></tr>
<tr><td class="paramname">cred_handle</td><td></td></tr>
<tr><td class="paramname">desired_object</td><td></td></tr>
<tr><td class="paramname">data_set</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="gaa3b3f808b0f410c099e3de2bec91affb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa3b3f808b0f410c099e3de2bec91affb">§ </a></span>gss_set_sec_context_option()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OM_uint32 GSS_CALLCONV gss_set_sec_context_option </td>
<td>(</td>
<td class="paramtype">OM_uint32 * </td>
<td class="paramname"><em>minor_status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gss_ctx_id_t * </td>
<td class="paramname"><em>context_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_OID </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const gss_buffer_t </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Security Context Option. </p>
<p>GSSAPI routine to initiate the sending of a security context See: <draft-ietf-cat-gssv2-cbind-04.txt></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">minor_status</td><td></td></tr>
<tr><td class="paramname">context_handle</td><td></td></tr>
<tr><td class="paramname">option</td><td></td></tr>
<tr><td class="paramname">value</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|