Debian Codegraph @

doc/reference/html/gss-api.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>api: GNU Generic Security Service (GSS) API Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="GNU Generic Security Service (GSS) API Reference Manual">
8 <link rel="up" href="intro.html" title="GNU Generic Security Service (GSS) API Reference Manual">
9 <link rel="prev" href="gss-gss.html" title="gss">
10 <link rel="next" href="gss-ext.html" title="ext">
11 <meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gss-api.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="intro.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="gss-gss.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gss-ext.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="gss-api"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="gss-api.top_of_page"></a>api</span></h2>
30 <p>api</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="gss-api.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="define_keyword">#define</td>
44 <td class="function_name">
45 <a class="link" href="gss-api.html#GSS-CALLING-ERROR:CAPS" title="GSS_CALLING_ERROR()">GSS_CALLING_ERROR</a><span class="c_punctuation">()</span>
46 </td>
47 </tr>
48 <tr>
49 <td class="define_keyword">#define</td>
50 <td class="function_name">
51 <a class="link" href="gss-api.html#GSS-ROUTINE-ERROR:CAPS" title="GSS_ROUTINE_ERROR()">GSS_ROUTINE_ERROR</a><span class="c_punctuation">()</span>
52 </td>
53 </tr>
54 <tr>
55 <td class="define_keyword">#define</td>
56 <td class="function_name">
57 <a class="link" href="gss-api.html#GSS-SUPPLEMENTARY-INFO:CAPS" title="GSS_SUPPLEMENTARY_INFO()">GSS_SUPPLEMENTARY_INFO</a><span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="define_keyword">#define</td>
62 <td class="function_name">
63 <a class="link" href="gss-api.html#GSS-ERROR:CAPS" title="GSS_ERROR()">GSS_ERROR</a><span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
69 </td>
70 <td class="function_name">
71 <a class="link" href="gss-api.html#gss-acquire-cred" title="gss_acquire_cred ()">gss_acquire_cred</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
77 </td>
78 <td class="function_name">
79 <a class="link" href="gss-api.html#gss-release-cred" title="gss_release_cred ()">gss_release_cred</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
85 </td>
86 <td class="function_name">
87 <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()">gss_init_sec_context</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
93 </td>
94 <td class="function_name">
95 <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()">gss_accept_sec_context</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
101 </td>
102 <td class="function_name">
103 <a class="link" href="gss-api.html#gss-process-context-token" title="gss_process_context_token ()">gss_process_context_token</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
109 </td>
110 <td class="function_name">
111 <a class="link" href="gss-api.html#gss-delete-sec-context" title="gss_delete_sec_context ()">gss_delete_sec_context</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
117 </td>
118 <td class="function_name">
119 <a class="link" href="gss-api.html#gss-context-time" title="gss_context_time ()">gss_context_time</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
125 </td>
126 <td class="function_name">
127 <a class="link" href="gss-api.html#gss-get-mic" title="gss_get_mic ()">gss_get_mic</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
133 </td>
134 <td class="function_name">
135 <a class="link" href="gss-api.html#gss-verify-mic" title="gss_verify_mic ()">gss_verify_mic</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
141 </td>
142 <td class="function_name">
143 <a class="link" href="gss-api.html#gss-wrap" title="gss_wrap ()">gss_wrap</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
149 </td>
150 <td class="function_name">
151 <a class="link" href="gss-api.html#gss-unwrap" title="gss_unwrap ()">gss_unwrap</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 <tr>
155 <td class="function_type">
156 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
157 </td>
158 <td class="function_name">
159 <a class="link" href="gss-api.html#gss-display-status" title="gss_display_status ()">gss_display_status</a> <span class="c_punctuation">()</span>
160 </td>
161 </tr>
162 <tr>
163 <td class="function_type">
164 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
165 </td>
166 <td class="function_name">
167 <a class="link" href="gss-api.html#gss-indicate-mechs" title="gss_indicate_mechs ()">gss_indicate_mechs</a> <span class="c_punctuation">()</span>
168 </td>
169 </tr>
170 <tr>
171 <td class="function_type">
172 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
173 </td>
174 <td class="function_name">
175 <a class="link" href="gss-api.html#gss-compare-name" title="gss_compare_name ()">gss_compare_name</a> <span class="c_punctuation">()</span>
176 </td>
177 </tr>
178 <tr>
179 <td class="function_type">
180 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
181 </td>
182 <td class="function_name">
183 <a class="link" href="gss-api.html#gss-display-name" title="gss_display_name ()">gss_display_name</a> <span class="c_punctuation">()</span>
184 </td>
185 </tr>
186 <tr>
187 <td class="function_type">
188 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
189 </td>
190 <td class="function_name">
191 <a class="link" href="gss-api.html#gss-import-name" title="gss_import_name ()">gss_import_name</a> <span class="c_punctuation">()</span>
192 </td>
193 </tr>
194 <tr>
195 <td class="function_type">
196 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
197 </td>
198 <td class="function_name">
199 <a class="link" href="gss-api.html#gss-export-name" title="gss_export_name ()">gss_export_name</a> <span class="c_punctuation">()</span>
200 </td>
201 </tr>
202 <tr>
203 <td class="function_type">
204 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
205 </td>
206 <td class="function_name">
207 <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()">gss_release_name</a> <span class="c_punctuation">()</span>
208 </td>
209 </tr>
210 <tr>
211 <td class="function_type">
212 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
213 </td>
214 <td class="function_name">
215 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()">gss_release_buffer</a> <span class="c_punctuation">()</span>
216 </td>
217 </tr>
218 <tr>
219 <td class="function_type">
220 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
221 </td>
222 <td class="function_name">
223 <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()">gss_release_oid_set</a> <span class="c_punctuation">()</span>
224 </td>
225 </tr>
226 <tr>
227 <td class="function_type">
228 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
229 </td>
230 <td class="function_name">
231 <a class="link" href="gss-api.html#gss-inquire-cred" title="gss_inquire_cred ()">gss_inquire_cred</a> <span class="c_punctuation">()</span>
232 </td>
233 </tr>
234 <tr>
235 <td class="function_type">
236 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
237 </td>
238 <td class="function_name">
239 <a class="link" href="gss-api.html#gss-inquire-context" title="gss_inquire_context ()">gss_inquire_context</a> <span class="c_punctuation">()</span>
240 </td>
241 </tr>
242 <tr>
243 <td class="function_type">
244 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
245 </td>
246 <td class="function_name">
247 <a class="link" href="gss-api.html#gss-wrap-size-limit" title="gss_wrap_size_limit ()">gss_wrap_size_limit</a> <span class="c_punctuation">()</span>
248 </td>
249 </tr>
250 <tr>
251 <td class="function_type">
252 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
253 </td>
254 <td class="function_name">
255 <a class="link" href="gss-api.html#gss-add-cred" title="gss_add_cred ()">gss_add_cred</a> <span class="c_punctuation">()</span>
256 </td>
257 </tr>
258 <tr>
259 <td class="function_type">
260 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
261 </td>
262 <td class="function_name">
263 <a class="link" href="gss-api.html#gss-inquire-cred-by-mech" title="gss_inquire_cred_by_mech ()">gss_inquire_cred_by_mech</a> <span class="c_punctuation">()</span>
264 </td>
265 </tr>
266 <tr>
267 <td class="function_type">
268 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
269 </td>
270 <td class="function_name">
271 <a class="link" href="gss-api.html#gss-export-sec-context" title="gss_export_sec_context ()">gss_export_sec_context</a> <span class="c_punctuation">()</span>
272 </td>
273 </tr>
274 <tr>
275 <td class="function_type">
276 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
277 </td>
278 <td class="function_name">
279 <a class="link" href="gss-api.html#gss-import-sec-context" title="gss_import_sec_context ()">gss_import_sec_context</a> <span class="c_punctuation">()</span>
280 </td>
281 </tr>
282 <tr>
283 <td class="function_type">
284 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
285 </td>
286 <td class="function_name">
287 <a class="link" href="gss-api.html#gss-create-empty-oid-set" title="gss_create_empty_oid_set ()">gss_create_empty_oid_set</a> <span class="c_punctuation">()</span>
288 </td>
289 </tr>
290 <tr>
291 <td class="function_type">
292 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
293 </td>
294 <td class="function_name">
295 <a class="link" href="gss-api.html#gss-add-oid-set-member" title="gss_add_oid_set_member ()">gss_add_oid_set_member</a> <span class="c_punctuation">()</span>
296 </td>
297 </tr>
298 <tr>
299 <td class="function_type">
300 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
301 </td>
302 <td class="function_name">
303 <a class="link" href="gss-api.html#gss-test-oid-set-member" title="gss_test_oid_set_member ()">gss_test_oid_set_member</a> <span class="c_punctuation">()</span>
304 </td>
305 </tr>
306 <tr>
307 <td class="function_type">
308 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
309 </td>
310 <td class="function_name">
311 <a class="link" href="gss-api.html#gss-inquire-names-for-mech" title="gss_inquire_names_for_mech ()">gss_inquire_names_for_mech</a> <span class="c_punctuation">()</span>
312 </td>
313 </tr>
314 <tr>
315 <td class="function_type">
316 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
317 </td>
318 <td class="function_name">
319 <a class="link" href="gss-api.html#gss-inquire-mechs-for-name" title="gss_inquire_mechs_for_name ()">gss_inquire_mechs_for_name</a> <span class="c_punctuation">()</span>
320 </td>
321 </tr>
322 <tr>
323 <td class="function_type">
324 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
325 </td>
326 <td class="function_name">
327 <a class="link" href="gss-api.html#gss-canonicalize-name" title="gss_canonicalize_name ()">gss_canonicalize_name</a> <span class="c_punctuation">()</span>
328 </td>
329 </tr>
330 <tr>
331 <td class="function_type">
332 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
333 </td>
334 <td class="function_name">
335 <a class="link" href="gss-api.html#gss-duplicate-name" title="gss_duplicate_name ()">gss_duplicate_name</a> <span class="c_punctuation">()</span>
336 </td>
337 </tr>
338 <tr>
339 <td class="function_type">
340 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
341 </td>
342 <td class="function_name">
343 <a class="link" href="gss-api.html#gss-sign" title="gss_sign ()">gss_sign</a> <span class="c_punctuation">()</span>
344 </td>
345 </tr>
346 <tr>
347 <td class="function_type">
348 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
349 </td>
350 <td class="function_name">
351 <a class="link" href="gss-api.html#gss-verify" title="gss_verify ()">gss_verify</a> <span class="c_punctuation">()</span>
352 </td>
353 </tr>
354 <tr>
355 <td class="function_type">
356 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
357 </td>
358 <td class="function_name">
359 <a class="link" href="gss-api.html#gss-seal" title="gss_seal ()">gss_seal</a> <span class="c_punctuation">()</span>
360 </td>
361 </tr>
362 <tr>
363 <td class="function_type">
364 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
365 </td>
366 <td class="function_name">
367 <a class="link" href="gss-api.html#gss-unseal" title="gss_unseal ()">gss_unseal</a> <span class="c_punctuation">()</span>
368 </td>
369 </tr>
370 <tr>
371 <td class="function_type">
372 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
373 </td>
374 <td class="function_name">
375 <a class="link" href="gss-api.html#gss-inquire-saslname-for-mech" title="gss_inquire_saslname_for_mech ()">gss_inquire_saslname_for_mech</a> <span class="c_punctuation">()</span>
376 </td>
377 </tr>
378 <tr>
379 <td class="function_type">
380 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
381 </td>
382 <td class="function_name">
383 <a class="link" href="gss-api.html#gss-inquire-mech-for-saslname" title="gss_inquire_mech_for_saslname ()">gss_inquire_mech_for_saslname</a> <span class="c_punctuation">()</span>
384 </td>
385 </tr>
386 <tr>
387 <td class="function_type">
388 <span class="returnvalue">int</span>
389 </td>
390 <td class="function_name">
391 <a class="link" href="gss-api.html#gss-oid-equal" title="gss_oid_equal ()">gss_oid_equal</a> <span class="c_punctuation">()</span>
392 </td>
393 </tr>
394 <tr>
395 <td class="function_type">
396 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
397 </td>
398 <td class="function_name">
399 <a class="link" href="gss-api.html#gss-encapsulate-token" title="gss_encapsulate_token ()">gss_encapsulate_token</a> <span class="c_punctuation">()</span>
400 </td>
401 </tr>
402 <tr>
403 <td class="function_type">
404 <a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
405 </td>
406 <td class="function_name">
407 <a class="link" href="gss-api.html#gss-decapsulate-token" title="gss_decapsulate_token ()">gss_decapsulate_token</a> <span class="c_punctuation">()</span>
408 </td>
409 </tr>
410 </tbody>
411 </table></div>
412 </div>
413 <div class="refsect1">
414 <a name="gss-api.other"></a><h2>Types and Values</h2>
415 <div class="informaltable"><table class="informaltable" width="100%" border="0">
416 <colgroup>
417 <col width="150px" class="other_proto_type">
418 <col class="other_proto_name">
419 </colgroup>
420 <tbody>
421 <tr>
422 <td class="typedef_keyword">typedef</td>
423 <td class="function_name"><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t">gss_ctx_id_t</a></td>
424 </tr>
425 <tr>
426 <td class="typedef_keyword">typedef</td>
427 <td class="function_name"><a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t">gss_cred_id_t</a></td>
428 </tr>
429 <tr>
430 <td class="typedef_keyword">typedef</td>
431 <td class="function_name"><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t">gss_name_t</a></td>
432 </tr>
433 <tr>
434 <td class="typedef_keyword">typedef</td>
435 <td class="function_name"><a class="link" href="gss-api.html#gss-uint32" title="gss_uint32">gss_uint32</a></td>
436 </tr>
437 <tr>
438 <td class="typedef_keyword">typedef</td>
439 <td class="function_name"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32">OM_uint32</a></td>
440 </tr>
441 <tr>
442 <td class="typedef_keyword">typedef</td>
443 <td class="function_name"><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t">gss_qop_t</a></td>
444 </tr>
445 <tr>
446 <td class="typedef_keyword">typedef</td>
447 <td class="function_name"><a class="link" href="gss-api.html#gss-cred-usage-t" title="gss_cred_usage_t">gss_cred_usage_t</a></td>
448 </tr>
449 <tr>
450 <td class="define_keyword">#define</td>
451 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-DELEG-FLAG:CAPS" title="GSS_C_DELEG_FLAG">GSS_C_DELEG_FLAG</a></td>
452 </tr>
453 <tr>
454 <td class="define_keyword">#define</td>
455 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-MUTUAL-FLAG:CAPS" title="GSS_C_MUTUAL_FLAG">GSS_C_MUTUAL_FLAG</a></td>
456 </tr>
457 <tr>
458 <td class="define_keyword">#define</td>
459 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-REPLAY-FLAG:CAPS" title="GSS_C_REPLAY_FLAG">GSS_C_REPLAY_FLAG</a></td>
460 </tr>
461 <tr>
462 <td class="define_keyword">#define</td>
463 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-SEQUENCE-FLAG:CAPS" title="GSS_C_SEQUENCE_FLAG">GSS_C_SEQUENCE_FLAG</a></td>
464 </tr>
465 <tr>
466 <td class="define_keyword">#define</td>
467 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-CONF-FLAG:CAPS" title="GSS_C_CONF_FLAG">GSS_C_CONF_FLAG</a></td>
468 </tr>
469 <tr>
470 <td class="define_keyword">#define</td>
471 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-INTEG-FLAG:CAPS" title="GSS_C_INTEG_FLAG">GSS_C_INTEG_FLAG</a></td>
472 </tr>
473 <tr>
474 <td class="define_keyword">#define</td>
475 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-ANON-FLAG:CAPS" title="GSS_C_ANON_FLAG">GSS_C_ANON_FLAG</a></td>
476 </tr>
477 <tr>
478 <td class="define_keyword">#define</td>
479 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-PROT-READY-FLAG:CAPS" title="GSS_C_PROT_READY_FLAG">GSS_C_PROT_READY_FLAG</a></td>
480 </tr>
481 <tr>
482 <td class="define_keyword">#define</td>
483 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-TRANS-FLAG:CAPS" title="GSS_C_TRANS_FLAG">GSS_C_TRANS_FLAG</a></td>
484 </tr>
485 <tr>
486 <td class="define_keyword">#define</td>
487 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-BOTH:CAPS" title="GSS_C_BOTH">GSS_C_BOTH</a></td>
488 </tr>
489 <tr>
490 <td class="define_keyword">#define</td>
491 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-INITIATE:CAPS" title="GSS_C_INITIATE">GSS_C_INITIATE</a></td>
492 </tr>
493 <tr>
494 <td class="define_keyword">#define</td>
495 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-ACCEPT:CAPS" title="GSS_C_ACCEPT">GSS_C_ACCEPT</a></td>
496 </tr>
497 <tr>
498 <td class="define_keyword">#define</td>
499 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-GSS-CODE:CAPS" title="GSS_C_GSS_CODE">GSS_C_GSS_CODE</a></td>
500 </tr>
501 <tr>
502 <td class="define_keyword">#define</td>
503 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-MECH-CODE:CAPS" title="GSS_C_MECH_CODE">GSS_C_MECH_CODE</a></td>
504 </tr>
505 <tr>
506 <td class="define_keyword">#define</td>
507 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-UNSPEC:CAPS" title="GSS_C_AF_UNSPEC">GSS_C_AF_UNSPEC</a></td>
508 </tr>
509 <tr>
510 <td class="define_keyword">#define</td>
511 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-LOCAL:CAPS" title="GSS_C_AF_LOCAL">GSS_C_AF_LOCAL</a></td>
512 </tr>
513 <tr>
514 <td class="define_keyword">#define</td>
515 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-INET:CAPS" title="GSS_C_AF_INET">GSS_C_AF_INET</a></td>
516 </tr>
517 <tr>
518 <td class="define_keyword">#define</td>
519 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-IMPLINK:CAPS" title="GSS_C_AF_IMPLINK">GSS_C_AF_IMPLINK</a></td>
520 </tr>
521 <tr>
522 <td class="define_keyword">#define</td>
523 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-PUP:CAPS" title="GSS_C_AF_PUP">GSS_C_AF_PUP</a></td>
524 </tr>
525 <tr>
526 <td class="define_keyword">#define</td>
527 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-CHAOS:CAPS" title="GSS_C_AF_CHAOS">GSS_C_AF_CHAOS</a></td>
528 </tr>
529 <tr>
530 <td class="define_keyword">#define</td>
531 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-NS:CAPS" title="GSS_C_AF_NS">GSS_C_AF_NS</a></td>
532 </tr>
533 <tr>
534 <td class="define_keyword">#define</td>
535 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-NBS:CAPS" title="GSS_C_AF_NBS">GSS_C_AF_NBS</a></td>
536 </tr>
537 <tr>
538 <td class="define_keyword">#define</td>
539 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-ECMA:CAPS" title="GSS_C_AF_ECMA">GSS_C_AF_ECMA</a></td>
540 </tr>
541 <tr>
542 <td class="define_keyword">#define</td>
543 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-DATAKIT:CAPS" title="GSS_C_AF_DATAKIT">GSS_C_AF_DATAKIT</a></td>
544 </tr>
545 <tr>
546 <td class="define_keyword">#define</td>
547 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-CCITT:CAPS" title="GSS_C_AF_CCITT">GSS_C_AF_CCITT</a></td>
548 </tr>
549 <tr>
550 <td class="define_keyword">#define</td>
551 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-SNA:CAPS" title="GSS_C_AF_SNA">GSS_C_AF_SNA</a></td>
552 </tr>
553 <tr>
554 <td class="define_keyword">#define</td>
555 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-DECnet" title="GSS_C_AF_DECnet">GSS_C_AF_DECnet</a></td>
556 </tr>
557 <tr>
558 <td class="define_keyword">#define</td>
559 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-DLI:CAPS" title="GSS_C_AF_DLI">GSS_C_AF_DLI</a></td>
560 </tr>
561 <tr>
562 <td class="define_keyword">#define</td>
563 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-LAT:CAPS" title="GSS_C_AF_LAT">GSS_C_AF_LAT</a></td>
564 </tr>
565 <tr>
566 <td class="define_keyword">#define</td>
567 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-HYLINK:CAPS" title="GSS_C_AF_HYLINK">GSS_C_AF_HYLINK</a></td>
568 </tr>
569 <tr>
570 <td class="define_keyword">#define</td>
571 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-APPLETALK:CAPS" title="GSS_C_AF_APPLETALK">GSS_C_AF_APPLETALK</a></td>
572 </tr>
573 <tr>
574 <td class="define_keyword">#define</td>
575 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-BSC:CAPS" title="GSS_C_AF_BSC">GSS_C_AF_BSC</a></td>
576 </tr>
577 <tr>
578 <td class="define_keyword">#define</td>
579 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-DSS:CAPS" title="GSS_C_AF_DSS">GSS_C_AF_DSS</a></td>
580 </tr>
581 <tr>
582 <td class="define_keyword">#define</td>
583 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-OSI:CAPS" title="GSS_C_AF_OSI">GSS_C_AF_OSI</a></td>
584 </tr>
585 <tr>
586 <td class="define_keyword">#define</td>
587 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-X25:CAPS" title="GSS_C_AF_X25">GSS_C_AF_X25</a></td>
588 </tr>
589 <tr>
590 <td class="define_keyword">#define</td>
591 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-AF-NULLADDR:CAPS" title="GSS_C_AF_NULLADDR">GSS_C_AF_NULLADDR</a></td>
592 </tr>
593 <tr>
594 <td class="define_keyword">#define</td>
595 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-NAME:CAPS" title="GSS_C_NO_NAME">GSS_C_NO_NAME</a></td>
596 </tr>
597 <tr>
598 <td class="define_keyword">#define</td>
599 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-BUFFER:CAPS" title="GSS_C_NO_BUFFER">GSS_C_NO_BUFFER</a></td>
600 </tr>
601 <tr>
602 <td class="define_keyword">#define</td>
603 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-OID:CAPS" title="GSS_C_NO_OID">GSS_C_NO_OID</a></td>
604 </tr>
605 <tr>
606 <td class="define_keyword">#define</td>
607 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-OID-SET:CAPS" title="GSS_C_NO_OID_SET">GSS_C_NO_OID_SET</a></td>
608 </tr>
609 <tr>
610 <td class="define_keyword">#define</td>
611 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-CONTEXT:CAPS" title="GSS_C_NO_CONTEXT">GSS_C_NO_CONTEXT</a></td>
612 </tr>
613 <tr>
614 <td class="define_keyword">#define</td>
615 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-CREDENTIAL:CAPS" title="GSS_C_NO_CREDENTIAL">GSS_C_NO_CREDENTIAL</a></td>
616 </tr>
617 <tr>
618 <td class="define_keyword">#define</td>
619 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NO-CHANNEL-BINDINGS:CAPS" title="GSS_C_NO_CHANNEL_BINDINGS">GSS_C_NO_CHANNEL_BINDINGS</a></td>
620 </tr>
621 <tr>
622 <td class="define_keyword">#define</td>
623 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-EMPTY-BUFFER:CAPS" title="GSS_C_EMPTY_BUFFER">GSS_C_EMPTY_BUFFER</a></td>
624 </tr>
625 <tr>
626 <td class="define_keyword">#define</td>
627 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NULL-OID:CAPS" title="GSS_C_NULL_OID">GSS_C_NULL_OID</a></td>
628 </tr>
629 <tr>
630 <td class="define_keyword">#define</td>
631 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NULL-OID-SET:CAPS" title="GSS_C_NULL_OID_SET">GSS_C_NULL_OID_SET</a></td>
632 </tr>
633 <tr>
634 <td class="define_keyword">#define</td>
635 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-QOP-DEFAULT:CAPS" title="GSS_C_QOP_DEFAULT">GSS_C_QOP_DEFAULT</a></td>
636 </tr>
637 <tr>
638 <td class="define_keyword">#define</td>
639 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-INDEFINITE:CAPS" title="GSS_C_INDEFINITE">GSS_C_INDEFINITE</a></td>
640 </tr>
641 <tr>
642 <td class="variable_type">extern gss_OID </td>
643 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-USER-NAME:CAPS" title="GSS_C_NT_USER_NAME">GSS_C_NT_USER_NAME</a></td>
644 </tr>
645 <tr>
646 <td class="variable_type">extern gss_OID </td>
647 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-MACHINE-UID-NAME:CAPS" title="GSS_C_NT_MACHINE_UID_NAME">GSS_C_NT_MACHINE_UID_NAME</a></td>
648 </tr>
649 <tr>
650 <td class="variable_type">extern gss_OID </td>
651 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-STRING-UID-NAME:CAPS" title="GSS_C_NT_STRING_UID_NAME">GSS_C_NT_STRING_UID_NAME</a></td>
652 </tr>
653 <tr>
654 <td class="variable_type">extern gss_OID </td>
655 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-HOSTBASED-SERVICE-X:CAPS" title="GSS_C_NT_HOSTBASED_SERVICE_X">GSS_C_NT_HOSTBASED_SERVICE_X</a></td>
656 </tr>
657 <tr>
658 <td class="variable_type">extern gss_OID </td>
659 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-HOSTBASED-SERVICE:CAPS" title="GSS_C_NT_HOSTBASED_SERVICE">GSS_C_NT_HOSTBASED_SERVICE</a></td>
660 </tr>
661 <tr>
662 <td class="variable_type">extern gss_OID </td>
663 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-ANONYMOUS:CAPS" title="GSS_C_NT_ANONYMOUS">GSS_C_NT_ANONYMOUS</a></td>
664 </tr>
665 <tr>
666 <td class="variable_type">extern gss_OID </td>
667 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-NT-EXPORT-NAME:CAPS" title="GSS_C_NT_EXPORT_NAME">GSS_C_NT_EXPORT_NAME</a></td>
668 </tr>
669 <tr>
670 <td class="define_keyword">#define</td>
671 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-COMPLETE:CAPS" title="GSS_S_COMPLETE">GSS_S_COMPLETE</a></td>
672 </tr>
673 <tr>
674 <td class="define_keyword">#define</td>
675 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-CALLING-ERROR-OFFSET:CAPS" title="GSS_C_CALLING_ERROR_OFFSET">GSS_C_CALLING_ERROR_OFFSET</a></td>
676 </tr>
677 <tr>
678 <td class="define_keyword">#define</td>
679 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-ROUTINE-ERROR-OFFSET:CAPS" title="GSS_C_ROUTINE_ERROR_OFFSET">GSS_C_ROUTINE_ERROR_OFFSET</a></td>
680 </tr>
681 <tr>
682 <td class="define_keyword">#define</td>
683 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-SUPPLEMENTARY-OFFSET:CAPS" title="GSS_C_SUPPLEMENTARY_OFFSET">GSS_C_SUPPLEMENTARY_OFFSET</a></td>
684 </tr>
685 <tr>
686 <td class="define_keyword">#define</td>
687 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-CALLING-ERROR-MASK:CAPS" title="GSS_C_CALLING_ERROR_MASK">GSS_C_CALLING_ERROR_MASK</a></td>
688 </tr>
689 <tr>
690 <td class="define_keyword">#define</td>
691 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-ROUTINE-ERROR-MASK:CAPS" title="GSS_C_ROUTINE_ERROR_MASK">GSS_C_ROUTINE_ERROR_MASK</a></td>
692 </tr>
693 <tr>
694 <td class="define_keyword">#define</td>
695 <td class="function_name"><a class="link" href="gss-api.html#GSS-C-SUPPLEMENTARY-MASK:CAPS" title="GSS_C_SUPPLEMENTARY_MASK">GSS_C_SUPPLEMENTARY_MASK</a></td>
696 </tr>
697 <tr>
698 <td class="define_keyword">#define</td>
699 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CALL-INACCESSIBLE-READ:CAPS" title="GSS_S_CALL_INACCESSIBLE_READ">GSS_S_CALL_INACCESSIBLE_READ</a></td>
700 </tr>
701 <tr>
702 <td class="define_keyword">#define</td>
703 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CALL-INACCESSIBLE-WRITE:CAPS" title="GSS_S_CALL_INACCESSIBLE_WRITE">GSS_S_CALL_INACCESSIBLE_WRITE</a></td>
704 </tr>
705 <tr>
706 <td class="define_keyword">#define</td>
707 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CALL-BAD-STRUCTURE:CAPS" title="GSS_S_CALL_BAD_STRUCTURE">GSS_S_CALL_BAD_STRUCTURE</a></td>
708 </tr>
709 <tr>
710 <td class="define_keyword">#define</td>
711 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-MECH:CAPS" title="GSS_S_BAD_MECH">GSS_S_BAD_MECH</a></td>
712 </tr>
713 <tr>
714 <td class="define_keyword">#define</td>
715 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-NAME:CAPS" title="GSS_S_BAD_NAME">GSS_S_BAD_NAME</a></td>
716 </tr>
717 <tr>
718 <td class="define_keyword">#define</td>
719 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-NAMETYPE:CAPS" title="GSS_S_BAD_NAMETYPE">GSS_S_BAD_NAMETYPE</a></td>
720 </tr>
721 <tr>
722 <td class="define_keyword">#define</td>
723 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-BINDINGS:CAPS" title="GSS_S_BAD_BINDINGS">GSS_S_BAD_BINDINGS</a></td>
724 </tr>
725 <tr>
726 <td class="define_keyword">#define</td>
727 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-STATUS:CAPS" title="GSS_S_BAD_STATUS">GSS_S_BAD_STATUS</a></td>
728 </tr>
729 <tr>
730 <td class="define_keyword">#define</td>
731 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-SIG:CAPS" title="GSS_S_BAD_SIG">GSS_S_BAD_SIG</a></td>
732 </tr>
733 <tr>
734 <td class="define_keyword">#define</td>
735 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-MIC:CAPS" title="GSS_S_BAD_MIC">GSS_S_BAD_MIC</a></td>
736 </tr>
737 <tr>
738 <td class="define_keyword">#define</td>
739 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-NO-CRED:CAPS" title="GSS_S_NO_CRED">GSS_S_NO_CRED</a></td>
740 </tr>
741 <tr>
742 <td class="define_keyword">#define</td>
743 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-NO-CONTEXT:CAPS" title="GSS_S_NO_CONTEXT">GSS_S_NO_CONTEXT</a></td>
744 </tr>
745 <tr>
746 <td class="define_keyword">#define</td>
747 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-DEFECTIVE-TOKEN:CAPS" title="GSS_S_DEFECTIVE_TOKEN">GSS_S_DEFECTIVE_TOKEN</a></td>
748 </tr>
749 <tr>
750 <td class="define_keyword">#define</td>
751 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-DEFECTIVE-CREDENTIAL:CAPS" title="GSS_S_DEFECTIVE_CREDENTIAL">GSS_S_DEFECTIVE_CREDENTIAL</a></td>
752 </tr>
753 <tr>
754 <td class="define_keyword">#define</td>
755 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CREDENTIALS-EXPIRED:CAPS" title="GSS_S_CREDENTIALS_EXPIRED">GSS_S_CREDENTIALS_EXPIRED</a></td>
756 </tr>
757 <tr>
758 <td class="define_keyword">#define</td>
759 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CONTEXT-EXPIRED:CAPS" title="GSS_S_CONTEXT_EXPIRED">GSS_S_CONTEXT_EXPIRED</a></td>
760 </tr>
761 <tr>
762 <td class="define_keyword">#define</td>
763 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-FAILURE:CAPS" title="GSS_S_FAILURE">GSS_S_FAILURE</a></td>
764 </tr>
765 <tr>
766 <td class="define_keyword">#define</td>
767 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-BAD-QOP:CAPS" title="GSS_S_BAD_QOP">GSS_S_BAD_QOP</a></td>
768 </tr>
769 <tr>
770 <td class="define_keyword">#define</td>
771 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-UNAUTHORIZED:CAPS" title="GSS_S_UNAUTHORIZED">GSS_S_UNAUTHORIZED</a></td>
772 </tr>
773 <tr>
774 <td class="define_keyword">#define</td>
775 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-UNAVAILABLE:CAPS" title="GSS_S_UNAVAILABLE">GSS_S_UNAVAILABLE</a></td>
776 </tr>
777 <tr>
778 <td class="define_keyword">#define</td>
779 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-DUPLICATE-ELEMENT:CAPS" title="GSS_S_DUPLICATE_ELEMENT">GSS_S_DUPLICATE_ELEMENT</a></td>
780 </tr>
781 <tr>
782 <td class="define_keyword">#define</td>
783 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-NAME-NOT-MN:CAPS" title="GSS_S_NAME_NOT_MN">GSS_S_NAME_NOT_MN</a></td>
784 </tr>
785 <tr>
786 <td class="define_keyword">#define</td>
787 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-CONTINUE-NEEDED:CAPS" title="GSS_S_CONTINUE_NEEDED">GSS_S_CONTINUE_NEEDED</a></td>
788 </tr>
789 <tr>
790 <td class="define_keyword">#define</td>
791 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-DUPLICATE-TOKEN:CAPS" title="GSS_S_DUPLICATE_TOKEN">GSS_S_DUPLICATE_TOKEN</a></td>
792 </tr>
793 <tr>
794 <td class="define_keyword">#define</td>
795 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-OLD-TOKEN:CAPS" title="GSS_S_OLD_TOKEN">GSS_S_OLD_TOKEN</a></td>
796 </tr>
797 <tr>
798 <td class="define_keyword">#define</td>
799 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-UNSEQ-TOKEN:CAPS" title="GSS_S_UNSEQ_TOKEN">GSS_S_UNSEQ_TOKEN</a></td>
800 </tr>
801 <tr>
802 <td class="define_keyword">#define</td>
803 <td class="function_name"><a class="link" href="gss-api.html#GSS-S-GAP-TOKEN:CAPS" title="GSS_S_GAP_TOKEN">GSS_S_GAP_TOKEN</a></td>
804 </tr>
805 <tr>
806 <td class="typedef_keyword">typedef</td>
807 <td class="function_name"><a class="link" href="gss-api.html#gss-const-buffer-t" title="gss_const_buffer_t">gss_const_buffer_t</a></td>
808 </tr>
809 <tr>
810 <td class="typedef_keyword">typedef</td>
811 <td class="function_name"><a class="link" href="gss-api.html#gss-const-ctx-id-t" title="gss_const_ctx_id_t">gss_const_ctx_id_t</a></td>
812 </tr>
813 <tr>
814 <td class="typedef_keyword">typedef</td>
815 <td class="function_name"><a class="link" href="gss-api.html#gss-const-cred-id-t" title="gss_const_cred_id_t">gss_const_cred_id_t</a></td>
816 </tr>
817 <tr>
818 <td class="typedef_keyword">typedef</td>
819 <td class="function_name"><a class="link" href="gss-api.html#gss-const-name-t" title="gss_const_name_t">gss_const_name_t</a></td>
820 </tr>
821 <tr>
822 <td class="typedef_keyword">typedef</td>
823 <td class="function_name"><a class="link" href="gss-api.html#gss-const-OID" title="gss_const_OID">gss_const_OID</a></td>
824 </tr>
825 <tr>
826 <td class="typedef_keyword">typedef</td>
827 <td class="function_name"><a class="link" href="gss-api.html#gss-const-OID-set" title="gss_const_OID_set">gss_const_OID_set</a></td>
828 </tr>
829 </tbody>
830 </table></div>
831 </div>
832 <div class="refsect1">
833 <a name="gss-api.description"></a><h2>Description</h2>
834 </div>
835 <div class="refsect1">
836 <a name="gss-api.functions_details"></a><h2>Functions</h2>
837 <div class="refsect2">
838 <a name="GSS-CALLING-ERROR:CAPS"></a><h3>GSS_CALLING_ERROR()</h3>
839 <pre class="programlisting">#define GSS_CALLING_ERROR(x)</pre>
840 </div>
841 <hr>
842 <div class="refsect2">
843 <a name="GSS-ROUTINE-ERROR:CAPS"></a><h3>GSS_ROUTINE_ERROR()</h3>
844 <pre class="programlisting">#define GSS_ROUTINE_ERROR(x)</pre>
845 </div>
846 <hr>
847 <div class="refsect2">
848 <a name="GSS-SUPPLEMENTARY-INFO:CAPS"></a><h3>GSS_SUPPLEMENTARY_INFO()</h3>
849 <pre class="programlisting">#define GSS_SUPPLEMENTARY_INFO(x)</pre>
850 </div>
851 <hr>
852 <div class="refsect2">
853 <a name="GSS-ERROR:CAPS"></a><h3>GSS_ERROR()</h3>
854 <pre class="programlisting">#define GSS_ERROR(x)</pre>
855 </div>
856 <hr>
857 <div class="refsect2">
858 <a name="gss-acquire-cred"></a><h3>gss_acquire_cred ()</h3>
859 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
860 gss_acquire_cred (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
861 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> desired_name</code></em>,
862 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> time_req</code></em>,
863 <em class="parameter"><code>const <span class="type">gss_OID_set</span> desired_mechs</code></em>,
864 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-usage-t" title="gss_cred_usage_t"><span class="type">gss_cred_usage_t</span></a> cred_usage</code></em>,
865 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> *output_cred_handle</code></em>,
866 <em class="parameter"><code><span class="type">gss_OID_set</span> *actual_mechs</code></em>,
867 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *time_rec</code></em>);</pre>
868 <p>Allows an application to acquire a handle for a pre-existing
869 credential by name. GSS-API implementations must impose a local
870 access-control policy on callers of this routine to prevent
871 unauthorized callers from acquiring credentials to which they are
872 not entitled. This routine is not intended to provide a "login to
873 the network" function, as such a function would involve the
874 creation of new credentials rather than merely acquiring a handle
875 to existing credentials. Such functions, if required, should be
876 defined in implementation-specific extensions to the API.</p>
877 <p>If desired_name is GSS_C_NO_NAME, the call is interpreted as a
878 request for a credential handle that will invoke default behavior
879 when passed to <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a> (if cred_usage is
880 GSS_C_INITIATE or GSS_C_BOTH) or <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> (if
881 cred_usage is GSS_C_ACCEPT or GSS_C_BOTH).</p>
882 <p>Mechanisms should honor the desired_mechs parameter, and return a
883 credential that is suitable to use only with the requested
884 mechanisms. An exception to this is the case where one underlying
885 credential element can be shared by multiple mechanisms; in this
886 case it is permissible for an implementation to indicate all
887 mechanisms with which the credential element may be used. If
888 desired_mechs is an empty set, behavior is undefined.</p>
889 <p>This routine is expected to be used primarily by context acceptors,
890 since implementations are likely to provide mechanism-specific ways
891 of obtaining GSS-API initiator credentials from the system login
892 process. Some implementations may therefore not support the
893 acquisition of GSS_C_INITIATE or GSS_C_BOTH credentials via
894 gss_acquire_cred for any name other than GSS_C_NO_NAME, or a name
895 produced by applying either gss_inquire_cred to a valid credential,
896 or gss_inquire_context to an active context.</p>
897 <p>If credential acquisition is time-consuming for a mechanism, the
898 mechanism may choose to delay the actual acquisition until the
899 credential is required (e.g. by gss_init_sec_context or
900 gss_accept_sec_context). Such mechanism-specific implementation
901 decisions should be invisible to the calling application; thus a
902 call of gss_inquire_cred immediately following the call of
903 gss_acquire_cred must return valid credential data, and may
904 therefore incur the overhead of a deferred credential acquisition.</p>
905 <div class="refsect3">
906 <a name="gss-acquire-cred.parameters"></a><h4>Parameters</h4>
907 <div class="informaltable"><table class="informaltable" width="100%" border="0">
908 <colgroup>
909 <col width="150px" class="parameters_name">
910 <col class="parameters_description">
911 <col width="200px" class="parameters_annotations">
912 </colgroup>
913 <tbody>
914 <tr>
915 <td class="parameter_name"><p>minor_status</p></td>
916 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
917 <td class="parameter_annotations"> </td>
918 </tr>
919 <tr>
920 <td class="parameter_name"><p>desired_name</p></td>
921 <td class="parameter_description"><p>(gss_name_t, read) Name of principal whose
922 credential should be acquired.</p></td>
923 <td class="parameter_annotations"> </td>
924 </tr>
925 <tr>
926 <td class="parameter_name"><p>time_req</p></td>
927 <td class="parameter_description"><p>(Integer, read, optional) Number of seconds that
928 credentials should remain valid. Specify GSS_C_INDEFINITE to
929 request that the credentials have the maximum permitted lifetime.</p></td>
930 <td class="parameter_annotations"> </td>
931 </tr>
932 <tr>
933 <td class="parameter_name"><p>desired_mechs</p></td>
934 <td class="parameter_description"><p>(Set of Object IDs, read, optional) Set of
935 underlying security mechanisms that may be used.
936 GSS_C_NO_OID_SET may be used to obtain an implementation-specific
937 default.</p></td>
938 <td class="parameter_annotations"> </td>
939 </tr>
940 <tr>
941 <td class="parameter_name"><p>cred_usage</p></td>
942 <td class="parameter_description"><p>(gss_cred_usage_t, read) GSS_C_BOTH - Credentials may
943 be used either to initiate or accept security contexts.
944 GSS_C_INITIATE - Credentials will only be used to initiate
945 security contexts. GSS_C_ACCEPT - Credentials will only be used
946 to accept security contexts.</p></td>
947 <td class="parameter_annotations"> </td>
948 </tr>
949 <tr>
950 <td class="parameter_name"><p>output_cred_handle</p></td>
951 <td class="parameter_description"><p>(gss_cred_id_t, modify) The returned
952 credential handle. Resources associated with this credential
953 handle must be released by the application after use with a call
954 to <a class="link" href="gss-api.html#gss-release-cred" title="gss_release_cred ()"><code class="function">gss_release_cred()</code></a>.</p></td>
955 <td class="parameter_annotations"> </td>
956 </tr>
957 <tr>
958 <td class="parameter_name"><p>actual_mechs</p></td>
959 <td class="parameter_description"><p>(Set of Object IDs, modify, optional) The set of
960 mechanisms for which the credential is valid. Storage associated
961 with the returned OID-set must be released by the application
962 after use with a call to <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>. Specify NULL if
963 not required.</p></td>
964 <td class="parameter_annotations"> </td>
965 </tr>
966 <tr>
967 <td class="parameter_name"><p>time_rec</p></td>
968 <td class="parameter_description"><p>(Integer, modify, optional) Actual number of seconds for
969 which the returned credentials will remain valid. If the
970 implementation does not support expiration of credentials, the
971 value GSS_C_INDEFINITE will be returned. Specify NULL if not
972 required.</p></td>
973 <td class="parameter_annotations"> </td>
974 </tr>
975 </tbody>
976 </table></div>
977 </div>
978 <div class="refsect3">
979 <a name="gss-acquire-cred.returns"></a><h4>Returns</h4>
980 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
981 <p><code class="literal">GSS_S_BAD_MECH</code>: Unavailable mechanism requested.</p>
982 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: Type contained within desired_name parameter
983 is not supported.</p>
984 <p><code class="literal">GSS_S_BAD_NAME</code>: Value supplied for desired_name parameter is ill
985 formed.</p>
986 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The credentials could not be acquired
987 Because they have expired.</p>
988 <p><code class="literal">GSS_S_NO_CRED</code>: No credentials were found for the specified name.</p>
989 </div>
990 </div>
991 <hr>
992 <div class="refsect2">
993 <a name="gss-release-cred"></a><h3>gss_release_cred ()</h3>
994 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
995 gss_release_cred (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
996 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> *cred_handle</code></em>);</pre>
997 <p>Informs GSS-API that the specified credential handle is no longer
998 required by the application, and frees associated resources. The
999 cred_handle is set to GSS_C_NO_CREDENTIAL on successful completion
1000 of this call.</p>
1001 <div class="refsect3">
1002 <a name="gss-release-cred.parameters"></a><h4>Parameters</h4>
1003 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1004 <colgroup>
1005 <col width="150px" class="parameters_name">
1006 <col class="parameters_description">
1007 <col width="200px" class="parameters_annotations">
1008 </colgroup>
1009 <tbody>
1010 <tr>
1011 <td class="parameter_name"><p>minor_status</p></td>
1012 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
1013 <td class="parameter_annotations"> </td>
1014 </tr>
1015 <tr>
1016 <td class="parameter_name"><p>cred_handle</p></td>
1017 <td class="parameter_description"><p>(gss_cred_id_t, modify, optional) Opaque handle
1018 identifying credential to be released. If GSS_C_NO_CREDENTIAL is
1019 supplied, the routine will complete successfully, but will do
1020 nothing.</p></td>
1021 <td class="parameter_annotations"> </td>
1022 </tr>
1023 </tbody>
1024 </table></div>
1025 </div>
1026 <div class="refsect3">
1027 <a name="gss-release-cred.returns"></a><h4>Returns</h4>
1028 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1029 <p><code class="literal">GSS_S_NO_CRED</code>: Credentials could not be accessed.</p>
1030 </div>
1031 </div>
1032 <hr>
1033 <div class="refsect2">
1034 <a name="gss-init-sec-context"></a><h3>gss_init_sec_context ()</h3>
1035 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1036 gss_init_sec_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1037 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> initiator_cred_handle</code></em>,
1038 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> *context_handle</code></em>,
1039 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> target_name</code></em>,
1040 <em class="parameter"><code>const <span class="type">gss_OID</span> mech_type</code></em>,
1041 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> req_flags</code></em>,
1042 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> time_req</code></em>,
1043 <em class="parameter"><code>const <span class="type">gss_channel_bindings_t</span> input_chan_bindings</code></em>,
1044 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> input_token</code></em>,
1045 <em class="parameter"><code><span class="type">gss_OID</span> *actual_mech_type</code></em>,
1046 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_token</code></em>,
1047 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *ret_flags</code></em>,
1048 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *time_rec</code></em>);</pre>
1049 <p>Initiates the establishment of a security context between the
1050 application and a remote peer. Initially, the input_token
1051 parameter should be specified either as GSS_C_NO_BUFFER, or as a
1052 pointer to a gss_buffer_desc object whose length field contains the
1053 value zero. The routine may return a output_token which should be
1054 transferred to the peer application, where the peer application
1055 will present it to gss_accept_sec_context. If no token need be
1056 sent, gss_init_sec_context will indicate this by setting the length
1057 field of the output_token argument to zero. To complete the context
1058 establishment, one or more reply tokens may be required from the
1059 peer application; if so, gss_init_sec_context will return a status
1060 containing the supplementary information bit GSS_S_CONTINUE_NEEDED.
1061 In this case, gss_init_sec_context should be called again when the
1062 reply token is received from the peer application, passing the
1063 reply token to gss_init_sec_context via the input_token parameters.</p>
1064 <p>Portable applications should be constructed to use the token length
1065 and return status to determine whether a token needs to be sent or
1066 waited for. Thus a typical portable caller should always invoke
1067 gss_init_sec_context within a loop:</p>
1068 <div class="refsect3">
1069 <a name="id-1.2.6.6.8.6"></a><h4>Portable applications should be constructed to use the token length
1070 and return status to determine whether a token needs to be sent or
1071 waited for. Thus a typical portable caller should always invoke
1072 gss_init_sec_context within a loop:</h4>
1073 <p>int context_established = 0;
1074 gss_ctx_id_t context_hdl = GSS_C_NO_CONTEXT;
1075 ...
1076 input_token-&gt;length = 0;</p>
1077 <p>while (!context_established) {
1078 maj_stat = gss_init_sec_context(&amp;min_stat,
1079 cred_hdl,
1080 &amp;context_hdl,
1081 target_name,
1082 desired_mech,
1083 desired_services,
1084 desired_time,
1085 input_bindings,
1086 input_token,
1087 &amp;actual_mech,
1088 output_token,
1089 &amp;actual_services,
1090 &amp;actual_time);
1091 if (GSS_ERROR(maj_stat)) {
1092 report_error(maj_stat, min_stat);
1093 };</p>
1094 <p> if (output_token-&gt;length != 0) {
1095 send_token_to_peer(output_token);
1096 gss_release_buffer(&amp;min_stat, output_token)
1097 };
1098 if (GSS_ERROR(maj_stat)) {</p>
1099 <p> if (context_hdl != GSS_C_NO_CONTEXT)
1100 gss_delete_sec_context(&amp;min_stat,
1101 &amp;context_hdl,
1102 GSS_C_NO_BUFFER);
1103 break;
1104 };</p>
1105 <p> if (maj_stat &amp; GSS_S_CONTINUE_NEEDED) {
1106 receive_token_from_peer(input_token);
1107 } else {
1108 context_established = 1;
1109 };</p>
1110 </div>
1111 <div class="refsect3">
1112 <a name="id-1.2.6.6.8.7"></a><h4>};</h4>
1113 <p>Whenever the routine returns a major status that includes the value
1114 GSS_S_CONTINUE_NEEDED, the context is not fully established and the
1115 following restrictions apply to the output parameters:</p>
1116 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1117 <li class="listitem"><p>The value returned via the time_rec parameter is undefined unless
1118 the accompanying ret_flags parameter contains the bit
1119 GSS_C_PROT_READY_FLAG, indicating that per-message services may be
1120 applied in advance of a successful completion status, the value
1121 returned via the actual_mech_type parameter is undefined until the
1122 routine returns a major status value of GSS_S_COMPLETE.</p></li>
1123 <li class="listitem"><p>The values of the GSS_C_DELEG_FLAG, GSS_C_MUTUAL_FLAG,
1124 GSS_C_REPLAY_FLAG, GSS_C_SEQUENCE_FLAG, GSS_C_CONF_FLAG,
1125 GSS_C_INTEG_FLAG and GSS_C_ANON_FLAG bits returned via the
1126 ret_flags parameter should contain the values that the
1127 implementation expects would be valid if context establishment were
1128 to succeed. In particular, if the application has requested a
1129 service such as delegation or anonymous authentication via the
1130 req_flags argument, and such a service is unavailable from the
1131 underlying mechanism, gss_init_sec_context should generate a token
1132 that will not provide the service, and indicate via the ret_flags
1133 argument that the service will not be supported. The application
1134 may choose to abort the context establishment by calling
1135 gss_delete_sec_context (if it cannot continue in the absence of the
1136 service), or it may choose to transmit the token and continue
1137 context establishment (if the service was merely desired but not
1138 mandatory).</p></li>
1139 <li class="listitem"><p>The values of the GSS_C_PROT_READY_FLAG and GSS_C_TRANS_FLAG bits
1140 within ret_flags should indicate the actual state at the time
1141 gss_init_sec_context returns, whether or not the context is fully
1142 established.</p></li>
1143 <li class="listitem"><p>GSS-API implementations that support per-message protection are
1144 encouraged to set the GSS_C_PROT_READY_FLAG in the final ret_flags
1145 returned to a caller (i.e. when accompanied by a GSS_S_COMPLETE
1146 status code). However, applications should not rely on this
1147 behavior as the flag was not defined in Version 1 of the GSS-API.
1148 Instead, applications should determine what per-message services
1149 are available after a successful context establishment according to
1150 the GSS_C_INTEG_FLAG and GSS_C_CONF_FLAG values.</p></li>
1151 <li class="listitem"><p>All other bits within the ret_flags argument should be set to
1152 zero.</p></li>
1153 </ul></div>
1154 <p>If the initial call of <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a> fails, the
1155 implementation should not create a context object, and should leave
1156 the value of the context_handle parameter set to GSS_C_NO_CONTEXT
1157 to indicate this. In the event of a failure on a subsequent call,
1158 the implementation is permitted to delete the "half-built" security
1159 context (in which case it should set the context_handle parameter
1160 to GSS_C_NO_CONTEXT), but the preferred behavior is to leave the
1161 security context untouched for the application to delete (using
1162 gss_delete_sec_context).</p>
1163 <p>During context establishment, the informational status bits
1164 GSS_S_OLD_TOKEN and GSS_S_DUPLICATE_TOKEN indicate fatal errors,
1165 and GSS-API mechanisms should always return them in association
1166 with a routine error of GSS_S_FAILURE. This requirement for
1167 pairing did not exist in version 1 of the GSS-API specification, so
1168 applications that wish to run over version 1 implementations must
1169 special-case these codes.</p>
1170 <p>The <code class="literal">req_flags</code> values:</p>
1171 <p><code class="literal">GSS_C_DELEG_FLAG</code>::</p>
1172 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1173 <li class="listitem"><p>True - Delegate credentials to remote peer.</p></li>
1174 <li class="listitem"><p>False - Don't delegate.</p></li>
1175 </ul></div>
1176 <p><code class="literal">GSS_C_MUTUAL_FLAG</code>::</p>
1177 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1178 <li class="listitem"><p>True - Request that remote peer authenticate itself.</p></li>
1179 <li class="listitem"><p>False - Authenticate self to remote peer only.</p></li>
1180 </ul></div>
1181 <p><code class="literal">GSS_C_REPLAY_FLAG</code>::</p>
1182 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1183 <li class="listitem"><p>True - Enable replay detection for messages protected with
1184 gss_wrap or gss_get_mic.</p></li>
1185 <li class="listitem"><p>False - Don't attempt to detect replayed messages.</p></li>
1186 </ul></div>
1187 <p><code class="literal">GSS_C_SEQUENCE_FLAG</code>::</p>
1188 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1189 <li class="listitem"><p>True - Enable detection of out-of-sequence protected messages.</p></li>
1190 <li class="listitem"><p>False - Don't attempt to detect out-of-sequence messages.</p></li>
1191 </ul></div>
1192 <p><code class="literal">GSS_C_CONF_FLAG</code>::</p>
1193 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1194 <li class="listitem"><p>True - Request that confidentiality service be made available
1195 (via gss_wrap).</p></li>
1196 <li class="listitem"><p>False - No per-message confidentiality service is required.</p></li>
1197 </ul></div>
1198 <p><code class="literal">GSS_C_INTEG_FLAG</code>::</p>
1199 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1200 <li class="listitem"><p>True - Request that integrity service be made available (via
1201 gss_wrap or gss_get_mic).</p></li>
1202 <li class="listitem"><p>False - No per-message integrity service is required.</p></li>
1203 </ul></div>
1204 <p><code class="literal">GSS_C_ANON_FLAG</code>::</p>
1205 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1206 <li class="listitem"><p>True - Do not reveal the initiator's identity to the acceptor.</p></li>
1207 <li class="listitem"><p>False - Authenticate normally.</p></li>
1208 </ul></div>
1209 <p>The <code class="literal">ret_flags</code> values:</p>
1210 <p><code class="literal">GSS_C_DELEG_FLAG</code>::</p>
1211 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1212 <li class="listitem"><p>True - Credentials were delegated to the remote peer.</p></li>
1213 <li class="listitem"><p>False - No credentials were delegated.</p></li>
1214 </ul></div>
1215 <p><code class="literal">GSS_C_MUTUAL_FLAG</code>::</p>
1216 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1217 <li class="listitem"><p>True - The remote peer has authenticated itself.</p></li>
1218 <li class="listitem"><p>False - Remote peer has not authenticated itself.</p></li>
1219 </ul></div>
1220 <p><code class="literal">GSS_C_REPLAY_FLAG</code>::</p>
1221 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1222 <li class="listitem"><p>True - replay of protected messages will be detected.</p></li>
1223 <li class="listitem"><p>False - replayed messages will not be detected.</p></li>
1224 </ul></div>
1225 <p><code class="literal">GSS_C_SEQUENCE_FLAG</code>::</p>
1226 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1227 <li class="listitem"><p>True - out-of-sequence protected messages will be detected.</p></li>
1228 <li class="listitem"><p>False - out-of-sequence messages will not be detected.</p></li>
1229 </ul></div>
1230 <p><code class="literal">GSS_C_CONF_FLAG</code>::</p>
1231 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1232 <li class="listitem"><p>True - Confidentiality service may be invoked by calling gss_wrap
1233 routine.</p></li>
1234 <li class="listitem"><p>False - No confidentiality service (via gss_wrap)
1235 available. gss_wrap will provide message encapsulation, data-origin
1236 authentication and integrity services only.</p></li>
1237 </ul></div>
1238 <p><code class="literal">GSS_C_INTEG_FLAG</code>::</p>
1239 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1240 <li class="listitem"><p>True - Integrity service may be invoked by calling either
1241 gss_get_mic or gss_wrap routines.</p></li>
1242 <li class="listitem"><p>False - Per-message integrity service unavailable.</p></li>
1243 </ul></div>
1244 <p><code class="literal">GSS_C_ANON_FLAG</code>::</p>
1245 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1246 <li class="listitem"><p>True - The initiator's identity has not been revealed, and will
1247 not be revealed if any emitted token is passed to the acceptor.</p></li>
1248 <li class="listitem"><p>False - The initiator's identity has been or will be
1249 authenticated normally.</p></li>
1250 </ul></div>
1251 <p><code class="literal">GSS_C_PROT_READY_FLAG</code>::</p>
1252 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1253 <li class="listitem"><p>True - Protection services (as specified by the states of the
1254 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available for use if the
1255 accompanying major status return value is either GSS_S_COMPLETE or
1256 GSS_S_CONTINUE_NEEDED.</p></li>
1257 <li class="listitem"><p>False - Protection services (as specified by the states of the
1258 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available only if the
1259 accompanying major status return value is GSS_S_COMPLETE.</p></li>
1260 </ul></div>
1261 <p><code class="literal">GSS_C_TRANS_FLAG</code>::</p>
1262 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1263 <li class="listitem"><p>True - The resultant security context may be transferred to other
1264 processes via a call to <a class="link" href="gss-api.html#gss-export-sec-context" title="gss_export_sec_context ()"><code class="function">gss_export_sec_context()</code></a>.</p></li>
1265 <li class="listitem"><p>False - The security context is not transferable.</p></li>
1266 </ul></div>
1267 <p>All other bits should be set to zero.</p>
1268 </div>
1269 <div class="refsect3">
1270 <a name="gss-init-sec-context.parameters"></a><h4>Parameters</h4>
1271 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1272 <colgroup>
1273 <col width="150px" class="parameters_name">
1274 <col class="parameters_description">
1275 <col width="200px" class="parameters_annotations">
1276 </colgroup>
1277 <tbody>
1278 <tr>
1279 <td class="parameter_name"><p>minor_status</p></td>
1280 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
1281 <td class="parameter_annotations"> </td>
1282 </tr>
1283 <tr>
1284 <td class="parameter_name"><p>initiator_cred_handle</p></td>
1285 <td class="parameter_description"><p>(gss_cred_id_t, read, optional) Handle for
1286 credentials claimed. Supply GSS_C_NO_CREDENTIAL to act as a
1287 default initiator principal. If no default initiator is defined,
1288 the function will return GSS_S_NO_CRED.</p></td>
1289 <td class="parameter_annotations"> </td>
1290 </tr>
1291 <tr>
1292 <td class="parameter_name"><p>context_handle</p></td>
1293 <td class="parameter_description"><p>(gss_ctx_id_t, read/modify) Context handle for new
1294 context. Supply GSS_C_NO_CONTEXT for first call; use value
1295 returned by first call in continuation calls. Resources
1296 associated with this context-handle must be released by the
1297 application after use with a call to <a class="link" href="gss-api.html#gss-delete-sec-context" title="gss_delete_sec_context ()"><code class="function">gss_delete_sec_context()</code></a>.</p></td>
1298 <td class="parameter_annotations"> </td>
1299 </tr>
1300 <tr>
1301 <td class="parameter_name"><p>target_name</p></td>
1302 <td class="parameter_description"><p>(gss_name_t, read) Name of target.</p></td>
1303 <td class="parameter_annotations"> </td>
1304 </tr>
1305 <tr>
1306 <td class="parameter_name"><p>mech_type</p></td>
1307 <td class="parameter_description"><p>(OID, read, optional) Object ID of desired
1308 mechanism. Supply GSS_C_NO_OID to obtain an implementation
1309 specific default.</p></td>
1310 <td class="parameter_annotations"> </td>
1311 </tr>
1312 <tr>
1313 <td class="parameter_name"><p>req_flags</p></td>
1314 <td class="parameter_description"><p>(bit-mask, read) Contains various independent flags,
1315 each of which requests that the context support a specific
1316 service option. Symbolic names are provided for each flag, and
1317 the symbolic names corresponding to the required flags should be
1318 logically-ORed together to form the bit-mask value. See below
1319 for the flags.</p></td>
1320 <td class="parameter_annotations"> </td>
1321 </tr>
1322 <tr>
1323 <td class="parameter_name"><p>time_req</p></td>
1324 <td class="parameter_description"><p>(Integer, read, optional) Desired number of seconds for
1325 which context should remain valid. Supply 0 to request a default
1326 validity period.</p></td>
1327 <td class="parameter_annotations"> </td>
1328 </tr>
1329 <tr>
1330 <td class="parameter_name"><p>input_chan_bindings</p></td>
1331 <td class="parameter_description"><p>(channel bindings, read, optional)
1332 Application-specified bindings. Allows application to securely
1333 bind channel identification information to the security context.
1334 Specify GSS_C_NO_CHANNEL_BINDINGS if channel bindings are not
1335 used.</p></td>
1336 <td class="parameter_annotations"> </td>
1337 </tr>
1338 <tr>
1339 <td class="parameter_name"><p>input_token</p></td>
1340 <td class="parameter_description"><p>(buffer, opaque, read, optional) Token received from
1341 peer application. Supply GSS_C_NO_BUFFER, or a pointer to a
1342 buffer containing the value GSS_C_EMPTY_BUFFER on initial call.</p></td>
1343 <td class="parameter_annotations"> </td>
1344 </tr>
1345 <tr>
1346 <td class="parameter_name"><p>actual_mech_type</p></td>
1347 <td class="parameter_description"><p>(OID, modify, optional) Actual mechanism used.
1348 The OID returned via this parameter will be a pointer to static
1349 storage that should be treated as read-only; In particular the
1350 application should not attempt to free it. Specify NULL if not
1351 required.</p></td>
1352 <td class="parameter_annotations"> </td>
1353 </tr>
1354 <tr>
1355 <td class="parameter_name"><p>output_token</p></td>
1356 <td class="parameter_description"><p>(buffer, opaque, modify) Token to be sent to peer
1357 application. If the length field of the returned buffer is zero,
1358 no token need be sent to the peer application. Storage
1359 associated with this buffer must be freed by the application
1360 after use with a call to <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
1361 <td class="parameter_annotations"> </td>
1362 </tr>
1363 <tr>
1364 <td class="parameter_name"><p>ret_flags</p></td>
1365 <td class="parameter_description"><p>(bit-mask, modify, optional) Contains various
1366 independent flags, each of which indicates that the context
1367 supports a specific service option. Specify NULL if not
1368 required. Symbolic names are provided for each flag, and the
1369 symbolic names corresponding to the required flags should be
1370 logically-ANDed with the ret_flags value to test whether a given
1371 option is supported by the context. See below for the flags.</p></td>
1372 <td class="parameter_annotations"> </td>
1373 </tr>
1374 <tr>
1375 <td class="parameter_name"><p>time_rec</p></td>
1376 <td class="parameter_description"><p>(Integer, modify, optional) Number of seconds for which
1377 the context will remain valid. If the implementation does not
1378 support context expiration, the value GSS_C_INDEFINITE will be
1379 returned. Specify NULL if not required.</p></td>
1380 <td class="parameter_annotations"> </td>
1381 </tr>
1382 </tbody>
1383 </table></div>
1384 </div>
1385 <div class="refsect3">
1386 <a name="gss-init-sec-context.returns"></a><h4>Returns</h4>
1387 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1388 <p><code class="literal">GSS_S_CONTINUE_NEEDED</code>: Indicates that a token from the peer
1389 application is required to complete the context, and that
1390 gss_init_sec_context must be called again with that token.</p>
1391 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: Indicates that consistency checks
1392 performed on the input_token failed.</p>
1393 <p><code class="literal">GSS_S_DEFECTIVE_CREDENTIAL</code>: Indicates that consistency checks
1394 performed on the credential failed.</p>
1395 <p><code class="literal">GSS_S_NO_CRED</code>: The supplied credentials were not valid for
1396 context initiation, or the credential handle did not reference any
1397 credentials.</p>
1398 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The referenced credentials have
1399 expired.</p>
1400 <p><code class="literal">GSS_S_BAD_BINDINGS</code>: The input_token contains different channel
1401 bindings to those specified via the input_chan_bindings parameter.</p>
1402 <p><code class="literal">GSS_S_BAD_SIG</code>: The input_token contains an invalid MIC, or a MIC
1403 that could not be verified.</p>
1404 <p><code class="literal">GSS_S_OLD_TOKEN</code>: The input_token was too old. This is a fatal
1405 error during context establishment.</p>
1406 <p><code class="literal">GSS_S_DUPLICATE_TOKEN</code>: The input_token is valid, but is a
1407 duplicate of a token already processed. This is a fatal error
1408 during context establishment.</p>
1409 <p><code class="literal">GSS_S_NO_CONTEXT</code>: Indicates that the supplied context handle did
1410 not refer to a valid context.</p>
1411 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: The provided target_name parameter contained
1412 an invalid or unsupported type of name.</p>
1413 <p><code class="literal">GSS_S_BAD_NAME</code>: The provided target_name parameter was
1414 ill-formed.</p>
1415 <p><code class="literal">GSS_S_BAD_MECH</code>: The specified mechanism is not supported by the
1416 provided credential, or is unrecognized by the implementation.</p>
1417 </div>
1418 </div>
1419 <hr>
1420 <div class="refsect2">
1421 <a name="gss-accept-sec-context"></a><h3>gss_accept_sec_context ()</h3>
1422 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1423 gss_accept_sec_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1424 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> *context_handle</code></em>,
1425 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> acceptor_cred_handle</code></em>,
1426 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> input_token_buffer</code></em>,
1427 <em class="parameter"><code>const <span class="type">gss_channel_bindings_t</span> input_chan_bindings</code></em>,
1428 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *src_name</code></em>,
1429 <em class="parameter"><code><span class="type">gss_OID</span> *mech_type</code></em>,
1430 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_token</code></em>,
1431 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *ret_flags</code></em>,
1432 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *time_rec</code></em>,
1433 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> *delegated_cred_handle</code></em>);</pre>
1434 <p>Allows a remotely initiated security context between the
1435 application and a remote peer to be established. The routine may
1436 return a output_token which should be transferred to the peer
1437 application, where the peer application will present it to
1438 gss_init_sec_context. If no token need be sent,
1439 gss_accept_sec_context will indicate this by setting the length
1440 field of the output_token argument to zero. To complete the
1441 context establishment, one or more reply tokens may be required
1442 from the peer application; if so, gss_accept_sec_context will
1443 return a status flag of GSS_S_CONTINUE_NEEDED, in which case it
1444 should be called again when the reply token is received from the
1445 peer application, passing the token to gss_accept_sec_context via
1446 the input_token parameters.</p>
1447 <p>Portable applications should be constructed to use the token length
1448 and return status to determine whether a token needs to be sent or
1449 waited for. Thus a typical portable caller should always invoke
1450 gss_accept_sec_context within a loop:</p>
1451 <div class="refsect3">
1452 <a name="id-1.2.6.6.9.6"></a><h4>Portable applications should be constructed to use the token length
1453 and return status to determine whether a token needs to be sent or
1454 waited for. Thus a typical portable caller should always invoke
1455 gss_accept_sec_context within a loop:</h4>
1456 <p>gss_ctx_id_t context_hdl = GSS_C_NO_CONTEXT;</p>
1457 <p>do {
1458 receive_token_from_peer(input_token);
1459 maj_stat = gss_accept_sec_context(&amp;min_stat,
1460 &amp;context_hdl,
1461 cred_hdl,
1462 input_token,
1463 input_bindings,
1464 &amp;client_name,
1465 &amp;mech_type,
1466 output_token,
1467 &amp;ret_flags,
1468 &amp;time_rec,
1469 &amp;deleg_cred);
1470 if (GSS_ERROR(maj_stat)) {
1471 report_error(maj_stat, min_stat);
1472 };
1473 if (output_token-&gt;length != 0) {
1474 send_token_to_peer(output_token);</p>
1475 <p> gss_release_buffer(&amp;min_stat, output_token);
1476 };
1477 if (GSS_ERROR(maj_stat)) {
1478 if (context_hdl != GSS_C_NO_CONTEXT)
1479 gss_delete_sec_context(&amp;min_stat,
1480 &amp;context_hdl,
1481 GSS_C_NO_BUFFER);
1482 break;
1483 };</p>
1484 </div>
1485 <div class="refsect3">
1486 <a name="id-1.2.6.6.9.7"></a><h4>} while (maj_stat &amp; GSS_S_CONTINUE_NEEDED);</h4>
1487 <p>Whenever the routine returns a major status that includes the value
1488 GSS_S_CONTINUE_NEEDED, the context is not fully established and the
1489 following restrictions apply to the output parameters:</p>
1490 <p>The value returned via the time_rec parameter is undefined Unless the
1491 accompanying ret_flags parameter contains the bit
1492 GSS_C_PROT_READY_FLAG, indicating that per-message services may be
1493 applied in advance of a successful completion status, the value
1494 returned via the mech_type parameter may be undefined until the
1495 routine returns a major status value of GSS_S_COMPLETE.</p>
1496 <p>The values of the GSS_C_DELEG_FLAG,
1497 GSS_C_MUTUAL_FLAG,GSS_C_REPLAY_FLAG, GSS_C_SEQUENCE_FLAG,
1498 GSS_C_CONF_FLAG,GSS_C_INTEG_FLAG and GSS_C_ANON_FLAG bits returned
1499 via the ret_flags parameter should contain the values that the
1500 implementation expects would be valid if context establishment were
1501 to succeed.</p>
1502 <p>The values of the GSS_C_PROT_READY_FLAG and GSS_C_TRANS_FLAG bits
1503 within ret_flags should indicate the actual state at the time
1504 gss_accept_sec_context returns, whether or not the context is fully
1505 established.</p>
1506 <p>Although this requires that GSS-API implementations set the
1507 GSS_C_PROT_READY_FLAG in the final ret_flags returned to a caller
1508 (i.e. when accompanied by a GSS_S_COMPLETE status code), applications
1509 should not rely on this behavior as the flag was not defined in
1510 Version 1 of the GSS-API. Instead, applications should be prepared to
1511 use per-message services after a successful context establishment,
1512 according to the GSS_C_INTEG_FLAG and GSS_C_CONF_FLAG values.</p>
1513 <p>All other bits within the ret_flags argument should be set to zero.
1514 While the routine returns GSS_S_CONTINUE_NEEDED, the values returned
1515 via the ret_flags argument indicate the services that the
1516 implementation expects to be available from the established context.</p>
1517 <p>If the initial call of <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> fails, the
1518 implementation should not create a context object, and should leave
1519 the value of the context_handle parameter set to GSS_C_NO_CONTEXT to
1520 indicate this. In the event of a failure on a subsequent call, the
1521 implementation is permitted to delete the "half-built" security
1522 context (in which case it should set the context_handle parameter to
1523 GSS_C_NO_CONTEXT), but the preferred behavior is to leave the
1524 security context (and the context_handle parameter) untouched for the
1525 application to delete (using gss_delete_sec_context).</p>
1526 <p>During context establishment, the informational status bits
1527 GSS_S_OLD_TOKEN and GSS_S_DUPLICATE_TOKEN indicate fatal errors, and
1528 GSS-API mechanisms should always return them in association with a
1529 routine error of GSS_S_FAILURE. This requirement for pairing did not
1530 exist in version 1 of the GSS-API specification, so applications that
1531 wish to run over version 1 implementations must special-case these
1532 codes.</p>
1533 <p>The <code class="literal">ret_flags</code> values:</p>
1534 <p><code class="literal">GSS_C_DELEG_FLAG</code>::</p>
1535 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1536 <li class="listitem"><p>True - Delegated credentials are available via the
1537 delegated_cred_handle parameter.</p></li>
1538 <li class="listitem"><p>False - No credentials were delegated.</p></li>
1539 </ul></div>
1540 <p><code class="literal">GSS_C_MUTUAL_FLAG</code>::</p>
1541 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1542 <li class="listitem"><p>True - Remote peer asked for mutual authentication.</p></li>
1543 <li class="listitem"><p>False - Remote peer did not ask for mutual authentication.</p></li>
1544 </ul></div>
1545 <p><code class="literal">GSS_C_REPLAY_FLAG</code>::</p>
1546 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1547 <li class="listitem"><p>True - replay of protected messages will be detected.</p></li>
1548 <li class="listitem"><p>False - replayed messages will not be detected.</p></li>
1549 </ul></div>
1550 <p><code class="literal">GSS_C_SEQUENCE_FLAG</code>::</p>
1551 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1552 <li class="listitem"><p>True - out-of-sequence protected messages will be detected.</p></li>
1553 <li class="listitem"><p>False - out-of-sequence messages will not be detected.</p></li>
1554 </ul></div>
1555 <p><code class="literal">GSS_C_CONF_FLAG</code>::</p>
1556 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1557 <li class="listitem"><p>True - Confidentiality service may be invoked by calling the
1558 gss_wrap routine.</p></li>
1559 <li class="listitem"><p>False - No confidentiality service (via gss_wrap)
1560 available. gss_wrap will provide message encapsulation, data-origin
1561 authentication and integrity services only.</p></li>
1562 </ul></div>
1563 <p><code class="literal">GSS_C_INTEG_FLAG</code>::</p>
1564 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1565 <li class="listitem"><p>True - Integrity service may be invoked by calling either
1566 gss_get_mic or gss_wrap routines.</p></li>
1567 <li class="listitem"><p>False - Per-message integrity service unavailable.</p></li>
1568 </ul></div>
1569 <p><code class="literal">GSS_C_ANON_FLAG</code>::</p>
1570 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1571 <li class="listitem"><p>True - The initiator does not wish to be authenticated; the
1572 src_name parameter (if requested) contains an anonymous internal
1573 name.</p></li>
1574 <li class="listitem"><p>False - The initiator has been authenticated normally.</p></li>
1575 </ul></div>
1576 <p><code class="literal">GSS_C_PROT_READY_FLAG</code>::</p>
1577 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1578 <li class="listitem"><p>True - Protection services (as specified by the states of the
1579 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available if the
1580 accompanying major status return value is either GSS_S_COMPLETE or
1581 GSS_S_CONTINUE_NEEDED.</p></li>
1582 <li class="listitem"><p>False - Protection services (as specified by the states of the
1583 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available only if the
1584 accompanying major status return value is GSS_S_COMPLETE.</p></li>
1585 </ul></div>
1586 <p><code class="literal">GSS_C_TRANS_FLAG</code>::</p>
1587 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1588 <li class="listitem"><p>True - The resultant security context may be transferred to other
1589 processes via a call to <a class="link" href="gss-api.html#gss-export-sec-context" title="gss_export_sec_context ()"><code class="function">gss_export_sec_context()</code></a>.</p></li>
1590 <li class="listitem"><p>False - The security context is not transferable.</p></li>
1591 </ul></div>
1592 <p>All other bits should be set to zero.</p>
1593 </div>
1594 <div class="refsect3">
1595 <a name="gss-accept-sec-context.parameters"></a><h4>Parameters</h4>
1596 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1597 <colgroup>
1598 <col width="150px" class="parameters_name">
1599 <col class="parameters_description">
1600 <col width="200px" class="parameters_annotations">
1601 </colgroup>
1602 <tbody>
1603 <tr>
1604 <td class="parameter_name"><p>minor_status</p></td>
1605 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
1606 <td class="parameter_annotations"> </td>
1607 </tr>
1608 <tr>
1609 <td class="parameter_name"><p>context_handle</p></td>
1610 <td class="parameter_description"><p>(gss_ctx_id_t, read/modify) Context handle for new
1611 context. Supply GSS_C_NO_CONTEXT for first call; use value
1612 returned in subsequent calls. Once <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> has
1613 returned a value via this parameter, resources have been assigned
1614 to the corresponding context, and must be freed by the
1615 application after use with a call to <a class="link" href="gss-api.html#gss-delete-sec-context" title="gss_delete_sec_context ()"><code class="function">gss_delete_sec_context()</code></a>.</p></td>
1616 <td class="parameter_annotations"> </td>
1617 </tr>
1618 <tr>
1619 <td class="parameter_name"><p>acceptor_cred_handle</p></td>
1620 <td class="parameter_description"><p>(gss_cred_id_t, read) Credential handle
1621 claimed by context acceptor. Specify GSS_C_NO_CREDENTIAL to
1622 accept the context as a default principal. If
1623 GSS_C_NO_CREDENTIAL is specified, but no default acceptor
1624 principal is defined, GSS_S_NO_CRED will be returned.</p></td>
1625 <td class="parameter_annotations"> </td>
1626 </tr>
1627 <tr>
1628 <td class="parameter_name"><p>input_token_buffer</p></td>
1629 <td class="parameter_description"><p>(buffer, opaque, read) Token obtained from
1630 remote application.</p></td>
1631 <td class="parameter_annotations"> </td>
1632 </tr>
1633 <tr>
1634 <td class="parameter_name"><p>input_chan_bindings</p></td>
1635 <td class="parameter_description"><p>(channel bindings, read, optional)
1636 Application- specified bindings. Allows application to securely
1637 bind channel identification information to the security context.
1638 If channel bindings are not used, specify
1639 GSS_C_NO_CHANNEL_BINDINGS.</p></td>
1640 <td class="parameter_annotations"> </td>
1641 </tr>
1642 <tr>
1643 <td class="parameter_name"><p>src_name</p></td>
1644 <td class="parameter_description"><p>(gss_name_t, modify, optional) Authenticated name of
1645 context initiator. After use, this name should be deallocated by
1646 passing it to <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>. If not required, specify NULL.</p></td>
1647 <td class="parameter_annotations"> </td>
1648 </tr>
1649 <tr>
1650 <td class="parameter_name"><p>mech_type</p></td>
1651 <td class="parameter_description"><p>(Object ID, modify, optional) Security mechanism used.
1652 The returned OID value will be a pointer into static storage, and
1653 should be treated as read-only by the caller (in particular, it
1654 does not need to be freed). If not required, specify NULL.</p></td>
1655 <td class="parameter_annotations"> </td>
1656 </tr>
1657 <tr>
1658 <td class="parameter_name"><p>output_token</p></td>
1659 <td class="parameter_description"><p>(buffer, opaque, modify) Token to be passed to peer
1660 application. If the length field of the returned token buffer is
1661 0, then no token need be passed to the peer application. If a
1662 non- zero length field is returned, the associated storage must
1663 be freed after use by the application with a call to
1664 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
1665 <td class="parameter_annotations"> </td>
1666 </tr>
1667 <tr>
1668 <td class="parameter_name"><p>ret_flags</p></td>
1669 <td class="parameter_description"><p>(bit-mask, modify, optional) Contains various
1670 independent flags, each of which indicates that the context
1671 supports a specific service option. If not needed, specify NULL.
1672 Symbolic names are provided for each flag, and the symbolic names
1673 corresponding to the required flags should be logically-ANDed
1674 with the ret_flags value to test whether a given option is
1675 supported by the context. See below for the flags.</p></td>
1676 <td class="parameter_annotations"> </td>
1677 </tr>
1678 <tr>
1679 <td class="parameter_name"><p>time_rec</p></td>
1680 <td class="parameter_description"><p>(Integer, modify, optional) Number of seconds for which
1681 the context will remain valid. Specify NULL if not required.</p></td>
1682 <td class="parameter_annotations"> </td>
1683 </tr>
1684 <tr>
1685 <td class="parameter_name"><p>delegated_cred_handle</p></td>
1686 <td class="parameter_description"><p>(gss_cred_id_t, modify, optional
1687 credential) Handle for credentials received from context
1688 initiator. Only valid if deleg_flag in ret_flags is true, in
1689 which case an explicit credential handle (i.e. not
1690 GSS_C_NO_CREDENTIAL) will be returned; if deleg_flag is false,
1691 <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> will set this parameter to
1692 GSS_C_NO_CREDENTIAL. If a credential handle is returned, the
1693 associated resources must be released by the application after
1694 use with a call to <a class="link" href="gss-api.html#gss-release-cred" title="gss_release_cred ()"><code class="function">gss_release_cred()</code></a>. Specify NULL if not
1695 required.</p></td>
1696 <td class="parameter_annotations"> </td>
1697 </tr>
1698 </tbody>
1699 </table></div>
1700 </div>
1701 <div class="refsect3">
1702 <a name="gss-accept-sec-context.returns"></a><h4>Returns</h4>
1703 <p><code class="literal">GSS_S_CONTINUE_NEEDED</code>: Indicates that a token from the peer
1704 application is required to complete the context, and that
1705 gss_accept_sec_context must be called again with that token.</p>
1706 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: Indicates that consistency checks
1707 performed on the input_token failed.</p>
1708 <p><code class="literal">GSS_S_DEFECTIVE_CREDENTIAL</code>: Indicates that consistency checks
1709 performed on the credential failed.</p>
1710 <p><code class="literal">GSS_S_NO_CRED</code>: The supplied credentials were not valid for
1711 context acceptance, or the credential handle did not reference any
1712 credentials.</p>
1713 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The referenced credentials have
1714 expired.</p>
1715 <p><code class="literal">GSS_S_BAD_BINDINGS</code>: The input_token contains different channel
1716 bindings to those specified via the input_chan_bindings parameter.</p>
1717 <p><code class="literal">GSS_S_NO_CONTEXT</code>: Indicates that the supplied context handle did
1718 not refer to a valid context.</p>
1719 <p><code class="literal">GSS_S_BAD_SIG</code>: The input_token contains an invalid MIC.</p>
1720 <p><code class="literal">GSS_S_OLD_TOKEN</code>: The input_token was too old. This is a fatal
1721 error during context establishment.</p>
1722 <p><code class="literal">GSS_S_DUPLICATE_TOKEN</code>: The input_token is valid, but is a
1723 duplicate of a token already processed. This is a fatal error
1724 during context establishment.</p>
1725 <p><code class="literal">GSS_S_BAD_MECH</code>: The received token specified a mechanism that is
1726 not supported by the implementation or the provided credential.</p>
1727 </div>
1728 </div>
1729 <hr>
1730 <div class="refsect2">
1731 <a name="gss-process-context-token"></a><h3>gss_process_context_token ()</h3>
1732 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1733 gss_process_context_token (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1734 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
1735 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> token_buffer</code></em>);</pre>
1736 <p>Provides a way to pass an asynchronous token to the security
1737 service. Most context-level tokens are emitted and processed
1738 synchronously by gss_init_sec_context and gss_accept_sec_context,
1739 and the application is informed as to whether further tokens are
1740 expected by the GSS_C_CONTINUE_NEEDED major status bit.
1741 Occasionally, a mechanism may need to emit a context-level token at
1742 a point when the peer entity is not expecting a token. For
1743 example, the initiator's final call to gss_init_sec_context may
1744 emit a token and return a status of GSS_S_COMPLETE, but the
1745 acceptor's call to gss_accept_sec_context may fail. The acceptor's
1746 mechanism may wish to send a token containing an error indication
1747 to the initiator, but the initiator is not expecting a token at
1748 this point, believing that the context is fully established.
1749 Gss_process_context_token provides a way to pass such a token to
1750 the mechanism at any time.</p>
1751 <div class="refsect3">
1752 <a name="gss-process-context-token.parameters"></a><h4>Parameters</h4>
1753 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1754 <colgroup>
1755 <col width="150px" class="parameters_name">
1756 <col class="parameters_description">
1757 <col width="200px" class="parameters_annotations">
1758 </colgroup>
1759 <tbody>
1760 <tr>
1761 <td class="parameter_name"><p>minor_status</p></td>
1762 <td class="parameter_description"><p>(Integer, modify) Implementation specific status code.</p></td>
1763 <td class="parameter_annotations"> </td>
1764 </tr>
1765 <tr>
1766 <td class="parameter_name"><p>context_handle</p></td>
1767 <td class="parameter_description"><p>(gss_ctx_id_t, read) Context handle of context on
1768 which token is to be processed</p></td>
1769 <td class="parameter_annotations"> </td>
1770 </tr>
1771 <tr>
1772 <td class="parameter_name"><p>token_buffer</p></td>
1773 <td class="parameter_description"><p>(buffer, opaque, read) Token to process.</p></td>
1774 <td class="parameter_annotations"> </td>
1775 </tr>
1776 </tbody>
1777 </table></div>
1778 </div>
1779 <div class="refsect3">
1780 <a name="gss-process-context-token.returns"></a><h4>Returns</h4>
1781 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1782 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: Indicates that consistency checks
1783 performed on the token failed.</p>
1784 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle did not refer to a valid
1785 context.</p>
1786 </div>
1787 </div>
1788 <hr>
1789 <div class="refsect2">
1790 <a name="gss-delete-sec-context"></a><h3>gss_delete_sec_context ()</h3>
1791 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1792 gss_delete_sec_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1793 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> *context_handle</code></em>,
1794 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_token</code></em>);</pre>
1795 <p>Delete a security context. gss_delete_sec_context will delete the
1796 local data structures associated with the specified security
1797 context, and may generate an output_token, which when passed to the
1798 peer gss_process_context_token will instruct it to do likewise. If
1799 no token is required by the mechanism, the GSS-API should set the
1800 length field of the output_token (if provided) to zero. No further
1801 security services may be obtained using the context specified by
1802 context_handle.</p>
1803 <p>In addition to deleting established security contexts,
1804 gss_delete_sec_context must also be able to delete "half-built"
1805 security contexts resulting from an incomplete sequence of
1806 <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a>/<a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> calls.</p>
1807 <p>The output_token parameter is retained for compatibility with
1808 version 1 of the GSS-API. It is recommended that both peer
1809 applications invoke gss_delete_sec_context passing the value
1810 GSS_C_NO_BUFFER for the output_token parameter, indicating that no
1811 token is required, and that gss_delete_sec_context should simply
1812 delete local context data structures. If the application does pass
1813 a valid buffer to gss_delete_sec_context, mechanisms are encouraged
1814 to return a zero-length token, indicating that no peer action is
1815 necessary, and that no token should be transferred by the
1816 application.</p>
1817 <div class="refsect3">
1818 <a name="gss-delete-sec-context.parameters"></a><h4>Parameters</h4>
1819 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1820 <colgroup>
1821 <col width="150px" class="parameters_name">
1822 <col class="parameters_description">
1823 <col width="200px" class="parameters_annotations">
1824 </colgroup>
1825 <tbody>
1826 <tr>
1827 <td class="parameter_name"><p>minor_status</p></td>
1828 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
1829 <td class="parameter_annotations"> </td>
1830 </tr>
1831 <tr>
1832 <td class="parameter_name"><p>context_handle</p></td>
1833 <td class="parameter_description"><p>(gss_ctx_id_t, modify) Context handle identifying
1834 context to delete. After deleting the context, the GSS-API will
1835 set this context handle to GSS_C_NO_CONTEXT.</p></td>
1836 <td class="parameter_annotations"> </td>
1837 </tr>
1838 <tr>
1839 <td class="parameter_name"><p>output_token</p></td>
1840 <td class="parameter_description"><p>(buffer, opaque, modify, optional) Token to be sent
1841 to remote application to instruct it to also delete the context.
1842 It is recommended that applications specify GSS_C_NO_BUFFER for
1843 this parameter, requesting local deletion only. If a buffer
1844 parameter is provided by the application, the mechanism may
1845 return a token in it; mechanisms that implement only local
1846 deletion should set the length field of this token to zero to
1847 indicate to the application that no token is to be sent to the
1848 peer.</p></td>
1849 <td class="parameter_annotations"> </td>
1850 </tr>
1851 </tbody>
1852 </table></div>
1853 </div>
1854 <div class="refsect3">
1855 <a name="gss-delete-sec-context.returns"></a><h4>Returns</h4>
1856 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1857 <p><code class="literal">GSS_S_NO_CONTEXT</code>: No valid context was supplied.</p>
1858 </div>
1859 </div>
1860 <hr>
1861 <div class="refsect2">
1862 <a name="gss-context-time"></a><h3>gss_context_time ()</h3>
1863 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1864 gss_context_time (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1865 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
1866 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *time_rec</code></em>);</pre>
1867 <p>Determines the number of seconds for which the specified context
1868 will remain valid.</p>
1869 <div class="refsect3">
1870 <a name="gss-context-time.parameters"></a><h4>Parameters</h4>
1871 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1872 <colgroup>
1873 <col width="150px" class="parameters_name">
1874 <col class="parameters_description">
1875 <col width="200px" class="parameters_annotations">
1876 </colgroup>
1877 <tbody>
1878 <tr>
1879 <td class="parameter_name"><p>minor_status</p></td>
1880 <td class="parameter_description"><p>(Integer, modify) Implementation specific status
1881 code.</p></td>
1882 <td class="parameter_annotations"> </td>
1883 </tr>
1884 <tr>
1885 <td class="parameter_name"><p>context_handle</p></td>
1886 <td class="parameter_description"><p>(gss_ctx_id_t, read) Identifies the context to be
1887 interrogated.</p></td>
1888 <td class="parameter_annotations"> </td>
1889 </tr>
1890 <tr>
1891 <td class="parameter_name"><p>time_rec</p></td>
1892 <td class="parameter_description"><p>(Integer, modify) Number of seconds that the context
1893 will remain valid. If the context has already expired, zero will
1894 be returned.</p></td>
1895 <td class="parameter_annotations"> </td>
1896 </tr>
1897 </tbody>
1898 </table></div>
1899 </div>
1900 <div class="refsect3">
1901 <a name="gss-context-time.returns"></a><h4>Returns</h4>
1902 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1903 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has already expired.</p>
1904 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle parameter did not identify a
1905 valid context</p>
1906 </div>
1907 </div>
1908 <hr>
1909 <div class="refsect2">
1910 <a name="gss-get-mic"></a><h3>gss_get_mic ()</h3>
1911 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1912 gss_get_mic (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1913 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
1914 <em class="parameter"><code><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t"><span class="type">gss_qop_t</span></a> qop_req</code></em>,
1915 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> message_buffer</code></em>,
1916 <em class="parameter"><code><span class="type">gss_buffer_t</span> message_token</code></em>);</pre>
1917 <p>Generates a cryptographic MIC for the supplied message, and places
1918 the MIC in a token for transfer to the peer application. The
1919 qop_req parameter allows a choice between several cryptographic
1920 algorithms, if supported by the chosen mechanism.</p>
1921 <p>Since some application-level protocols may wish to use tokens
1922 emitted by <a class="link" href="gss-api.html#gss-wrap" title="gss_wrap ()"><code class="function">gss_wrap()</code></a> to provide "secure framing", implementations
1923 must support derivation of MICs from zero-length messages.</p>
1924 <div class="refsect3">
1925 <a name="gss-get-mic.parameters"></a><h4>Parameters</h4>
1926 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1927 <colgroup>
1928 <col width="150px" class="parameters_name">
1929 <col class="parameters_description">
1930 <col width="200px" class="parameters_annotations">
1931 </colgroup>
1932 <tbody>
1933 <tr>
1934 <td class="parameter_name"><p>minor_status</p></td>
1935 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
1936 <td class="parameter_annotations"> </td>
1937 </tr>
1938 <tr>
1939 <td class="parameter_name"><p>context_handle</p></td>
1940 <td class="parameter_description"><p>(gss_ctx_id_t, read) Identifies the context on
1941 which the message will be sent.</p></td>
1942 <td class="parameter_annotations"> </td>
1943 </tr>
1944 <tr>
1945 <td class="parameter_name"><p>qop_req</p></td>
1946 <td class="parameter_description"><p>(gss_qop_t, read, optional) Specifies requested quality
1947 of protection. Callers are encouraged, on portability grounds,
1948 to accept the default quality of protection offered by the chosen
1949 mechanism, which may be requested by specifying GSS_C_QOP_DEFAULT
1950 for this parameter. If an unsupported protection strength is
1951 requested, gss_get_mic will return a major_status of
1952 GSS_S_BAD_QOP.</p></td>
1953 <td class="parameter_annotations"> </td>
1954 </tr>
1955 <tr>
1956 <td class="parameter_name"><p>message_buffer</p></td>
1957 <td class="parameter_description"><p>(buffer, opaque, read) Message to be protected.</p></td>
1958 <td class="parameter_annotations"> </td>
1959 </tr>
1960 <tr>
1961 <td class="parameter_name"><p>message_token</p></td>
1962 <td class="parameter_description"><p>(buffer, opaque, modify) Buffer to receive token. The
1963 application must free storage associated with this buffer after
1964 use with a call to <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
1965 <td class="parameter_annotations"> </td>
1966 </tr>
1967 </tbody>
1968 </table></div>
1969 </div>
1970 <div class="refsect3">
1971 <a name="gss-get-mic.returns"></a><h4>Returns</h4>
1972 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
1973 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has already expired.</p>
1974 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle parameter did not identify a
1975 valid context.</p>
1976 <p><code class="literal">GSS_S_BAD_QOP</code>: The specified QOP is not supported by the
1977 mechanism.</p>
1978 </div>
1979 </div>
1980 <hr>
1981 <div class="refsect2">
1982 <a name="gss-verify-mic"></a><h3>gss_verify_mic ()</h3>
1983 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
1984 gss_verify_mic (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
1985 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
1986 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> message_buffer</code></em>,
1987 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> token_buffer</code></em>,
1988 <em class="parameter"><code><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t"><span class="type">gss_qop_t</span></a> *qop_state</code></em>);</pre>
1989 <p>Verifies that a cryptographic MIC, contained in the token
1990 parameter, fits the supplied message. The qop_state parameter
1991 allows a message recipient to determine the strength of protection
1992 that was applied to the message.</p>
1993 <p>Since some application-level protocols may wish to use tokens
1994 emitted by <a class="link" href="gss-api.html#gss-wrap" title="gss_wrap ()"><code class="function">gss_wrap()</code></a> to provide "secure framing", implementations
1995 must support the calculation and verification of MICs over
1996 zero-length messages.</p>
1997 <div class="refsect3">
1998 <a name="gss-verify-mic.parameters"></a><h4>Parameters</h4>
1999 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2000 <colgroup>
2001 <col width="150px" class="parameters_name">
2002 <col class="parameters_description">
2003 <col width="200px" class="parameters_annotations">
2004 </colgroup>
2005 <tbody>
2006 <tr>
2007 <td class="parameter_name"><p>minor_status</p></td>
2008 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2009 <td class="parameter_annotations"> </td>
2010 </tr>
2011 <tr>
2012 <td class="parameter_name"><p>context_handle</p></td>
2013 <td class="parameter_description"><p>(gss_ctx_id_t, read) Identifies the context on
2014 which the message arrived.</p></td>
2015 <td class="parameter_annotations"> </td>
2016 </tr>
2017 <tr>
2018 <td class="parameter_name"><p>message_buffer</p></td>
2019 <td class="parameter_description"><p>(buffer, opaque, read) Message to be verified.</p></td>
2020 <td class="parameter_annotations"> </td>
2021 </tr>
2022 <tr>
2023 <td class="parameter_name"><p>token_buffer</p></td>
2024 <td class="parameter_description"><p>(buffer, opaque, read) Token associated with
2025 message.</p></td>
2026 <td class="parameter_annotations"> </td>
2027 </tr>
2028 <tr>
2029 <td class="parameter_name"><p>qop_state</p></td>
2030 <td class="parameter_description"><p>(gss_qop_t, modify, optional) Quality of protection
2031 gained from MIC Specify NULL if not required.</p></td>
2032 <td class="parameter_annotations"> </td>
2033 </tr>
2034 </tbody>
2035 </table></div>
2036 </div>
2037 <div class="refsect3">
2038 <a name="gss-verify-mic.returns"></a><h4>Returns</h4>
2039 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2040 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: The token failed consistency checks.</p>
2041 <p><code class="literal">GSS_S_BAD_SIG</code>: The MIC was incorrect.</p>
2042 <p><code class="literal">GSS_S_DUPLICATE_TOKEN</code>: The token was valid, and contained a
2043 correct MIC for the message, but it had already been processed.</p>
2044 <p><code class="literal">GSS_S_OLD_TOKEN</code>: The token was valid, and contained a correct MIC
2045 for the message, but it is too old to check for duplication.</p>
2046 <p><code class="literal">GSS_S_UNSEQ_TOKEN</code>: The token was valid, and contained a correct
2047 MIC for the message, but has been verified out of sequence; a later
2048 token has already been received.</p>
2049 <p><code class="literal">GSS_S_GAP_TOKEN</code>: The token was valid, and contained a correct MIC
2050 for the message, but has been verified out of sequence; an earlier
2051 expected token has not yet been received.</p>
2052 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has already expired.</p>
2053 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle parameter did not identify a
2054 valid context.</p>
2055 </div>
2056 </div>
2057 <hr>
2058 <div class="refsect2">
2059 <a name="gss-wrap"></a><h3>gss_wrap ()</h3>
2060 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2061 gss_wrap (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2062 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
2063 <em class="parameter"><code><span class="type">int</span> conf_req_flag</code></em>,
2064 <em class="parameter"><code><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t"><span class="type">gss_qop_t</span></a> qop_req</code></em>,
2065 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> input_message_buffer</code></em>,
2066 <em class="parameter"><code><span class="type">int</span> *conf_state</code></em>,
2067 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_message_buffer</code></em>);</pre>
2068 <p>Attaches a cryptographic MIC and optionally encrypts the specified
2069 input_message. The output_message contains both the MIC and the
2070 message. The qop_req parameter allows a choice between several
2071 cryptographic algorithms, if supported by the chosen mechanism.</p>
2072 <p>Since some application-level protocols may wish to use tokens
2073 emitted by <a class="link" href="gss-api.html#gss-wrap" title="gss_wrap ()"><code class="function">gss_wrap()</code></a> to provide "secure framing", implementations
2074 must support the wrapping of zero-length messages.</p>
2075 <div class="refsect3">
2076 <a name="gss-wrap.parameters"></a><h4>Parameters</h4>
2077 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2078 <colgroup>
2079 <col width="150px" class="parameters_name">
2080 <col class="parameters_description">
2081 <col width="200px" class="parameters_annotations">
2082 </colgroup>
2083 <tbody>
2084 <tr>
2085 <td class="parameter_name"><p>minor_status</p></td>
2086 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2087 <td class="parameter_annotations"> </td>
2088 </tr>
2089 <tr>
2090 <td class="parameter_name"><p>context_handle</p></td>
2091 <td class="parameter_description"><p>(gss_ctx_id_t, read) Identifies the context on
2092 which the message will be sent.</p></td>
2093 <td class="parameter_annotations"> </td>
2094 </tr>
2095 <tr>
2096 <td class="parameter_name"><p>conf_req_flag</p></td>
2097 <td class="parameter_description"><p>(boolean, read) Non-zero - Both confidentiality and
2098 integrity services are requested. Zero - Only integrity service is
2099 requested.</p></td>
2100 <td class="parameter_annotations"> </td>
2101 </tr>
2102 <tr>
2103 <td class="parameter_name"><p>qop_req</p></td>
2104 <td class="parameter_description"><p>(gss_qop_t, read, optional) Specifies required quality of
2105 protection. A mechanism-specific default may be requested by
2106 setting qop_req to GSS_C_QOP_DEFAULT. If an unsupported
2107 protection strength is requested, gss_wrap will return a
2108 major_status of GSS_S_BAD_QOP.</p></td>
2109 <td class="parameter_annotations"> </td>
2110 </tr>
2111 <tr>
2112 <td class="parameter_name"><p>input_message_buffer</p></td>
2113 <td class="parameter_description"><p>(buffer, opaque, read) Message to be
2114 protected.</p></td>
2115 <td class="parameter_annotations"> </td>
2116 </tr>
2117 <tr>
2118 <td class="parameter_name"><p>conf_state</p></td>
2119 <td class="parameter_description"><p>(boolean, modify, optional) Non-zero -
2120 Confidentiality, data origin authentication and integrity
2121 services have been applied. Zero - Integrity and data origin
2122 services only has been applied. Specify NULL if not required.</p></td>
2123 <td class="parameter_annotations"> </td>
2124 </tr>
2125 <tr>
2126 <td class="parameter_name"><p>output_message_buffer</p></td>
2127 <td class="parameter_description"><p>(buffer, opaque, modify) Buffer to receive
2128 protected message. Storage associated with this message must be
2129 freed by the application after use with a call to
2130 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
2131 <td class="parameter_annotations"> </td>
2132 </tr>
2133 </tbody>
2134 </table></div>
2135 </div>
2136 <div class="refsect3">
2137 <a name="gss-wrap.returns"></a><h4>Returns</h4>
2138 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2139 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has already expired.</p>
2140 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle parameter did not identify a
2141 valid context.</p>
2142 <p><code class="literal">GSS_S_BAD_QOP</code>: The specified QOP is not supported by the
2143 mechanism.</p>
2144 </div>
2145 </div>
2146 <hr>
2147 <div class="refsect2">
2148 <a name="gss-unwrap"></a><h3>gss_unwrap ()</h3>
2149 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2150 gss_unwrap (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2151 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
2152 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> input_message_buffer</code></em>,
2153 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_message_buffer</code></em>,
2154 <em class="parameter"><code><span class="type">int</span> *conf_state</code></em>,
2155 <em class="parameter"><code><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t"><span class="type">gss_qop_t</span></a> *qop_state</code></em>);</pre>
2156 <p>Converts a message previously protected by gss_wrap back to a
2157 usable form, verifying the embedded MIC. The conf_state parameter
2158 indicates whether the message was encrypted; the qop_state
2159 parameter indicates the strength of protection that was used to
2160 provide the confidentiality and integrity services.</p>
2161 <p>Since some application-level protocols may wish to use tokens
2162 emitted by <a class="link" href="gss-api.html#gss-wrap" title="gss_wrap ()"><code class="function">gss_wrap()</code></a> to provide "secure framing", implementations
2163 must support the wrapping and unwrapping of zero-length messages.</p>
2164 <div class="refsect3">
2165 <a name="gss-unwrap.parameters"></a><h4>Parameters</h4>
2166 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2167 <colgroup>
2168 <col width="150px" class="parameters_name">
2169 <col class="parameters_description">
2170 <col width="200px" class="parameters_annotations">
2171 </colgroup>
2172 <tbody>
2173 <tr>
2174 <td class="parameter_name"><p>minor_status</p></td>
2175 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2176 <td class="parameter_annotations"> </td>
2177 </tr>
2178 <tr>
2179 <td class="parameter_name"><p>context_handle</p></td>
2180 <td class="parameter_description"><p>(gss_ctx_id_t, read) Identifies the context on
2181 which the message arrived.</p></td>
2182 <td class="parameter_annotations"> </td>
2183 </tr>
2184 <tr>
2185 <td class="parameter_name"><p>input_message_buffer</p></td>
2186 <td class="parameter_description"><p>(buffer, opaque, read) Protected message.</p></td>
2187 <td class="parameter_annotations"> </td>
2188 </tr>
2189 <tr>
2190 <td class="parameter_name"><p>output_message_buffer</p></td>
2191 <td class="parameter_description"><p>(buffer, opaque, modify) Buffer to receive
2192 unwrapped message. Storage associated with this buffer must be
2193 freed by the application after use use with a call to
2194 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
2195 <td class="parameter_annotations"> </td>
2196 </tr>
2197 <tr>
2198 <td class="parameter_name"><p>conf_state</p></td>
2199 <td class="parameter_description"><p>(boolean, modify, optional) Non-zero - Confidentiality
2200 and integrity protection were used. Zero - Integrity service only
2201 was used. Specify NULL if not required.</p></td>
2202 <td class="parameter_annotations"> </td>
2203 </tr>
2204 <tr>
2205 <td class="parameter_name"><p>qop_state</p></td>
2206 <td class="parameter_description"><p>(gss_qop_t, modify, optional) Quality of protection
2207 provided. Specify NULL if not required.</p></td>
2208 <td class="parameter_annotations"> </td>
2209 </tr>
2210 </tbody>
2211 </table></div>
2212 </div>
2213 <div class="refsect3">
2214 <a name="gss-unwrap.returns"></a><h4>Returns</h4>
2215 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2216 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: The token failed consistency checks.</p>
2217 <p><code class="literal">GSS_S_BAD_SIG</code>: The MIC was incorrect.</p>
2218 <p><code class="literal">GSS_S_DUPLICATE_TOKEN</code>: The token was valid, and contained a
2219 correct MIC for the message, but it had already been processed.</p>
2220 <p><code class="literal">GSS_S_OLD_TOKEN</code>: The token was valid, and contained a correct MIC
2221 for the message, but it is too old to check for duplication.</p>
2222 <p><code class="literal">GSS_S_UNSEQ_TOKEN</code>: The token was valid, and contained a correct
2223 MIC for the message, but has been verified out of sequence; a later
2224 token has already been received.</p>
2225 <p><code class="literal">GSS_S_GAP_TOKEN</code>: The token was valid, and contained a correct MIC
2226 for the message, but has been verified out of sequence; an earlier
2227 expected token has not yet been received.</p>
2228 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has already expired.</p>
2229 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context_handle parameter did not identify a
2230 valid context.</p>
2231 </div>
2232 </div>
2233 <hr>
2234 <div class="refsect2">
2235 <a name="gss-display-status"></a><h3>gss_display_status ()</h3>
2236 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2237 gss_display_status (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2238 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> status_value</code></em>,
2239 <em class="parameter"><code><span class="type">int</span> status_type</code></em>,
2240 <em class="parameter"><code>const <span class="type">gss_OID</span> mech_type</code></em>,
2241 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *message_context</code></em>,
2242 <em class="parameter"><code><span class="type">gss_buffer_t</span> status_string</code></em>);</pre>
2243 <p>Allows an application to obtain a textual representation of a
2244 GSS-API status code, for display to the user or for logging
2245 purposes. Since some status values may indicate multiple
2246 conditions, applications may need to call gss_display_status
2247 multiple times, each call generating a single text string. The
2248 message_context parameter is used by gss_display_status to store
2249 state information about which error messages have already been
2250 extracted from a given status_value; message_context must be
2251 initialized to 0 by the application prior to the first call, and
2252 gss_display_status will return a non-zero value in this parameter
2253 if there are further messages to extract.</p>
2254 <p>The message_context parameter contains all state information
2255 required by gss_display_status in order to extract further messages
2256 from the status_value; even when a non-zero value is returned in
2257 this parameter, the application is not required to call
2258 gss_display_status again unless subsequent messages are desired.
2259 The following code extracts all messages from a given status code
2260 and prints them to stderr:</p>
2261 <div class="refsect3">
2262 <a name="id-1.2.6.6.17.6"></a><h4>The message_context parameter contains all state information
2263 required by gss_display_status in order to extract further messages
2264 from the status_value; even when a non-zero value is returned in
2265 this parameter, the application is not required to call
2266 gss_display_status again unless subsequent messages are desired.
2267 The following code extracts all messages from a given status code
2268 and prints them to stderr:</h4>
2269 <p>OM_uint32 message_context;
2270 OM_uint32 status_code;
2271 OM_uint32 maj_status;
2272 OM_uint32 min_status;
2273 gss_buffer_desc status_string;</p>
2274 <p> ...</p>
2275 <p>message_context = 0;</p>
2276 <p>do {
2277 maj_status = gss_display_status (
2278 &amp;min_status,
2279 status_code,
2280 GSS_C_GSS_CODE,
2281 GSS_C_NO_OID,
2282 &amp;message_context,
2283 &amp;status_string)</p>
2284 <p> fprintf(stderr,
2285 "%.*s\n",
2286 (int)status_string.length,</p>
2287 <p> (char *)status_string.value);</p>
2288 <p> gss_release_buffer(&amp;min_status, &amp;status_string);</p>
2289 </div>
2290 <div class="refsect3">
2291 <a name="id-1.2.6.6.17.7"></a><h4>} while (message_context != 0);</h4>
2292 </div>
2293 <div class="refsect3">
2294 <a name="gss-display-status.parameters"></a><h4>Parameters</h4>
2295 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2296 <colgroup>
2297 <col width="150px" class="parameters_name">
2298 <col class="parameters_description">
2299 <col width="200px" class="parameters_annotations">
2300 </colgroup>
2301 <tbody>
2302 <tr>
2303 <td class="parameter_name"><p>minor_status</p></td>
2304 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
2305 <td class="parameter_annotations"> </td>
2306 </tr>
2307 <tr>
2308 <td class="parameter_name"><p>status_value</p></td>
2309 <td class="parameter_description"><p>(Integer, read) Status value to be converted.</p></td>
2310 <td class="parameter_annotations"> </td>
2311 </tr>
2312 <tr>
2313 <td class="parameter_name"><p>status_type</p></td>
2314 <td class="parameter_description"><p>(Integer, read) GSS_C_GSS_CODE - status_value is a
2315 GSS status code. GSS_C_MECH_CODE - status_value is a mechanism
2316 status code.</p></td>
2317 <td class="parameter_annotations"> </td>
2318 </tr>
2319 <tr>
2320 <td class="parameter_name"><p>mech_type</p></td>
2321 <td class="parameter_description"><p>(Object ID, read, optional) Underlying mechanism (used
2322 to interpret a minor status value). Supply GSS_C_NO_OID to obtain
2323 the system default.</p></td>
2324 <td class="parameter_annotations"> </td>
2325 </tr>
2326 <tr>
2327 <td class="parameter_name"><p>message_context</p></td>
2328 <td class="parameter_description"><p>(Integer, read/modify) Should be initialized to
2329 zero by the application prior to the first call. On return from
2330 <a class="link" href="gss-api.html#gss-display-status" title="gss_display_status ()"><code class="function">gss_display_status()</code></a>, a non-zero status_value parameter indicates
2331 that additional messages may be extracted from the status code
2332 via subsequent calls to <a class="link" href="gss-api.html#gss-display-status" title="gss_display_status ()"><code class="function">gss_display_status()</code></a>, passing the same
2333 status_value, status_type, mech_type, and message_context
2334 parameters.</p></td>
2335 <td class="parameter_annotations"> </td>
2336 </tr>
2337 <tr>
2338 <td class="parameter_name"><p>status_string</p></td>
2339 <td class="parameter_description"><p>(buffer, character string, modify) Textual
2340 interpretation of the status_value. Storage associated with this
2341 parameter must be freed by the application after use with a call
2342 to <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
2343 <td class="parameter_annotations"> </td>
2344 </tr>
2345 </tbody>
2346 </table></div>
2347 </div>
2348 <div class="refsect3">
2349 <a name="gss-display-status.returns"></a><h4>Returns</h4>
2350 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2351 <p><code class="literal">GSS_S_BAD_MECH</code>: Indicates that translation in accordance with an
2352 unsupported mechanism type was requested.</p>
2353 <p><code class="literal">GSS_S_BAD_STATUS</code>: The status value was not recognized, or the
2354 status type was neither GSS_C_GSS_CODE nor GSS_C_MECH_CODE.</p>
2355 </div>
2356 </div>
2357 <hr>
2358 <div class="refsect2">
2359 <a name="gss-indicate-mechs"></a><h3>gss_indicate_mechs ()</h3>
2360 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2361 gss_indicate_mechs (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2362 <em class="parameter"><code><span class="type">gss_OID_set</span> *mech_set</code></em>);</pre>
2363 <p>Allows an application to determine which underlying security
2364 mechanisms are available.</p>
2365 <div class="refsect3">
2366 <a name="gss-indicate-mechs.parameters"></a><h4>Parameters</h4>
2367 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2368 <colgroup>
2369 <col width="150px" class="parameters_name">
2370 <col class="parameters_description">
2371 <col width="200px" class="parameters_annotations">
2372 </colgroup>
2373 <tbody>
2374 <tr>
2375 <td class="parameter_name"><p>minor_status</p></td>
2376 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
2377 <td class="parameter_annotations"> </td>
2378 </tr>
2379 <tr>
2380 <td class="parameter_name"><p>mech_set</p></td>
2381 <td class="parameter_description"><p>(set of Object IDs, modify) Set of
2382 implementation-supported mechanisms. The returned gss_OID_set
2383 value will be a dynamically-allocated OID set, that should be
2384 released by the caller after use with a call to
2385 <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>.</p></td>
2386 <td class="parameter_annotations"> </td>
2387 </tr>
2388 </tbody>
2389 </table></div>
2390 </div>
2391 <div class="refsect3">
2392 <a name="gss-indicate-mechs.returns"></a><h4>Returns</h4>
2393 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2394 </div>
2395 </div>
2396 <hr>
2397 <div class="refsect2">
2398 <a name="gss-compare-name"></a><h3>gss_compare_name ()</h3>
2399 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2400 gss_compare_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2401 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> name1</code></em>,
2402 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> name2</code></em>,
2403 <em class="parameter"><code><span class="type">int</span> *name_equal</code></em>);</pre>
2404 <p>Allows an application to compare two internal-form names to
2405 determine whether they refer to the same entity.</p>
2406 <p>If either name presented to gss_compare_name denotes an anonymous
2407 principal, the routines should indicate that the two names do not
2408 refer to the same identity.</p>
2409 <div class="refsect3">
2410 <a name="gss-compare-name.parameters"></a><h4>Parameters</h4>
2411 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2412 <colgroup>
2413 <col width="150px" class="parameters_name">
2414 <col class="parameters_description">
2415 <col width="200px" class="parameters_annotations">
2416 </colgroup>
2417 <tbody>
2418 <tr>
2419 <td class="parameter_name"><p>minor_status</p></td>
2420 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2421 <td class="parameter_annotations"> </td>
2422 </tr>
2423 <tr>
2424 <td class="parameter_name"><p>name1</p></td>
2425 <td class="parameter_description"><p>(gss_name_t, read) Internal-form name.</p></td>
2426 <td class="parameter_annotations"> </td>
2427 </tr>
2428 <tr>
2429 <td class="parameter_name"><p>name2</p></td>
2430 <td class="parameter_description"><p>(gss_name_t, read) Internal-form name.</p></td>
2431 <td class="parameter_annotations"> </td>
2432 </tr>
2433 <tr>
2434 <td class="parameter_name"><p>name_equal</p></td>
2435 <td class="parameter_description"><p>(boolean, modify) Non-zero - names refer to same
2436 entity. Zero - names refer to different entities (strictly, the
2437 names are not known to refer to the same identity).</p></td>
2438 <td class="parameter_annotations"> </td>
2439 </tr>
2440 </tbody>
2441 </table></div>
2442 </div>
2443 <div class="refsect3">
2444 <a name="gss-compare-name.returns"></a><h4>Returns</h4>
2445 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2446 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: The two names were of incomparable types.</p>
2447 <p><code class="literal">GSS_S_BAD_NAME</code>: One or both of name1 or name2 was ill-formed.</p>
2448 </div>
2449 </div>
2450 <hr>
2451 <div class="refsect2">
2452 <a name="gss-display-name"></a><h3>gss_display_name ()</h3>
2453 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2454 gss_display_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2455 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> input_name</code></em>,
2456 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_name_buffer</code></em>,
2457 <em class="parameter"><code><span class="type">gss_OID</span> *output_name_type</code></em>);</pre>
2458 <p>Allows an application to obtain a textual representation of an
2459 opaque internal-form name for display purposes. The syntax of a
2460 printable name is defined by the GSS-API implementation.</p>
2461 <p>If input_name denotes an anonymous principal, the implementation
2462 should return the gss_OID value GSS_C_NT_ANONYMOUS as the
2463 output_name_type, and a textual name that is syntactically distinct
2464 from all valid supported printable names in output_name_buffer.</p>
2465 <p>If input_name was created by a call to gss_import_name, specifying
2466 GSS_C_NO_OID as the name-type, implementations that employ lazy
2467 conversion between name types may return GSS_C_NO_OID via the
2468 output_name_type parameter.</p>
2469 <div class="refsect3">
2470 <a name="gss-display-name.parameters"></a><h4>Parameters</h4>
2471 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2472 <colgroup>
2473 <col width="150px" class="parameters_name">
2474 <col class="parameters_description">
2475 <col width="200px" class="parameters_annotations">
2476 </colgroup>
2477 <tbody>
2478 <tr>
2479 <td class="parameter_name"><p>minor_status</p></td>
2480 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2481 <td class="parameter_annotations"> </td>
2482 </tr>
2483 <tr>
2484 <td class="parameter_name"><p>input_name</p></td>
2485 <td class="parameter_description"><p>(gss_name_t, read) Name to be displayed.</p></td>
2486 <td class="parameter_annotations"> </td>
2487 </tr>
2488 <tr>
2489 <td class="parameter_name"><p>output_name_buffer</p></td>
2490 <td class="parameter_description"><p>(buffer, character-string, modify) Buffer to
2491 receive textual name string. The application must free storage
2492 associated with this name after use with a call to
2493 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
2494 <td class="parameter_annotations"> </td>
2495 </tr>
2496 <tr>
2497 <td class="parameter_name"><p>output_name_type</p></td>
2498 <td class="parameter_description"><p>(Object ID, modify, optional) The type of the
2499 returned name. The returned gss_OID will be a pointer into
2500 static storage, and should be treated as read-only by the caller
2501 (in particular, the application should not attempt to free
2502 it). Specify NULL if not required.</p></td>
2503 <td class="parameter_annotations"> </td>
2504 </tr>
2505 </tbody>
2506 </table></div>
2507 </div>
2508 <div class="refsect3">
2509 <a name="gss-display-name.returns"></a><h4>Returns</h4>
2510 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2511 <p><code class="literal">GSS_S_BAD_NAME</code>: <em class="parameter"><code>input_name</code></em>
2512 was ill-formed.</p>
2513 </div>
2514 </div>
2515 <hr>
2516 <div class="refsect2">
2517 <a name="gss-import-name"></a><h3>gss_import_name ()</h3>
2518 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2519 gss_import_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2520 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> input_name_buffer</code></em>,
2521 <em class="parameter"><code>const <span class="type">gss_OID</span> input_name_type</code></em>,
2522 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *output_name</code></em>);</pre>
2523 <p>Convert a contiguous string name to internal form. In general, the
2524 internal name returned (via the <em class="parameter"><code>output_name</code></em>
2525 parameter) will not
2526 be an MN; the exception to this is if the <em class="parameter"><code>input_name_type</code></em>
2527
2528 indicates that the contiguous string provided via the
2529 <em class="parameter"><code>input_name_buffer</code></em>
2530 parameter is of type GSS_C_NT_EXPORT_NAME, in
2531 which case the returned internal name will be an MN for the
2532 mechanism that exported the name.</p>
2533 <div class="refsect3">
2534 <a name="gss-import-name.parameters"></a><h4>Parameters</h4>
2535 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2536 <colgroup>
2537 <col width="150px" class="parameters_name">
2538 <col class="parameters_description">
2539 <col width="200px" class="parameters_annotations">
2540 </colgroup>
2541 <tbody>
2542 <tr>
2543 <td class="parameter_name"><p>minor_status</p></td>
2544 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2545 <td class="parameter_annotations"> </td>
2546 </tr>
2547 <tr>
2548 <td class="parameter_name"><p>input_name_buffer</p></td>
2549 <td class="parameter_description"><p>(buffer, octet-string, read) Buffer containing
2550 contiguous string name to convert.</p></td>
2551 <td class="parameter_annotations"> </td>
2552 </tr>
2553 <tr>
2554 <td class="parameter_name"><p>input_name_type</p></td>
2555 <td class="parameter_description"><p>(Object ID, read, optional) Object ID specifying
2556 type of printable name. Applications may specify either
2557 GSS_C_NO_OID to use a mechanism-specific default printable
2558 syntax, or an OID recognized by the GSS-API implementation to
2559 name a specific namespace.</p></td>
2560 <td class="parameter_annotations"> </td>
2561 </tr>
2562 <tr>
2563 <td class="parameter_name"><p>output_name</p></td>
2564 <td class="parameter_description"><p>(gss_name_t, modify) Returned name in internal form.
2565 Storage associated with this name must be freed by the
2566 application after use with a call to <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>.</p></td>
2567 <td class="parameter_annotations"> </td>
2568 </tr>
2569 </tbody>
2570 </table></div>
2571 </div>
2572 <div class="refsect3">
2573 <a name="gss-import-name.returns"></a><h4>Returns</h4>
2574 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2575 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: The input_name_type was unrecognized.</p>
2576 <p><code class="literal">GSS_S_BAD_NAME</code>: The input_name parameter could not be interpreted
2577 as a name of the specified type.</p>
2578 <p><code class="literal">GSS_S_BAD_MECH</code>: The input name-type was GSS_C_NT_EXPORT_NAME, but
2579 the mechanism contained within the input-name is not supported.</p>
2580 </div>
2581 </div>
2582 <hr>
2583 <div class="refsect2">
2584 <a name="gss-export-name"></a><h3>gss_export_name ()</h3>
2585 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2586 gss_export_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2587 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> input_name</code></em>,
2588 <em class="parameter"><code><span class="type">gss_buffer_t</span> exported_name</code></em>);</pre>
2589 <p>To produce a canonical contiguous string representation of a
2590 mechanism name (MN), suitable for direct comparison (e.g. with
2591 memcmp) for use in authorization functions (e.g. matching entries
2592 in an access-control list). The <em class="parameter"><code>input_name</code></em>
2593 parameter must specify
2594 a valid MN (i.e. an internal name generated by
2595 <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> or by <a class="link" href="gss-api.html#gss-canonicalize-name" title="gss_canonicalize_name ()"><code class="function">gss_canonicalize_name()</code></a>).</p>
2596 <div class="refsect3">
2597 <a name="gss-export-name.parameters"></a><h4>Parameters</h4>
2598 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2599 <colgroup>
2600 <col width="150px" class="parameters_name">
2601 <col class="parameters_description">
2602 <col width="200px" class="parameters_annotations">
2603 </colgroup>
2604 <tbody>
2605 <tr>
2606 <td class="parameter_name"><p>minor_status</p></td>
2607 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2608 <td class="parameter_annotations"> </td>
2609 </tr>
2610 <tr>
2611 <td class="parameter_name"><p>input_name</p></td>
2612 <td class="parameter_description"><p>(gss_name_t, read) The MN to be exported.</p></td>
2613 <td class="parameter_annotations"> </td>
2614 </tr>
2615 <tr>
2616 <td class="parameter_name"><p>exported_name</p></td>
2617 <td class="parameter_description"><p>(gss_buffer_t, octet-string, modify) The canonical
2618 contiguous string form of <em class="parameter"><code>input_name</code></em>
2619 . Storage associated with
2620 this string must freed by the application after use with
2621 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
2622 <td class="parameter_annotations"> </td>
2623 </tr>
2624 </tbody>
2625 </table></div>
2626 </div>
2627 <div class="refsect3">
2628 <a name="gss-export-name.returns"></a><h4>Returns</h4>
2629 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2630 <p><code class="literal">GSS_S_NAME_NOT_MN</code>: The provided internal name was not a mechanism
2631 name.</p>
2632 <p><code class="literal">GSS_S_BAD_NAME</code>: The provided internal name was ill-formed.</p>
2633 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: The internal name was of a type not supported
2634 by the GSS-API implementation.</p>
2635 </div>
2636 </div>
2637 <hr>
2638 <div class="refsect2">
2639 <a name="gss-release-name"></a><h3>gss_release_name ()</h3>
2640 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2641 gss_release_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2642 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *name</code></em>);</pre>
2643 <p>Free GSSAPI-allocated storage associated with an internal-form
2644 name. The name is set to GSS_C_NO_NAME on successful completion of
2645 this call.</p>
2646 <div class="refsect3">
2647 <a name="gss-release-name.parameters"></a><h4>Parameters</h4>
2648 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2649 <colgroup>
2650 <col width="150px" class="parameters_name">
2651 <col class="parameters_description">
2652 <col width="200px" class="parameters_annotations">
2653 </colgroup>
2654 <tbody>
2655 <tr>
2656 <td class="parameter_name"><p>minor_status</p></td>
2657 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2658 <td class="parameter_annotations"> </td>
2659 </tr>
2660 <tr>
2661 <td class="parameter_name"><p>name</p></td>
2662 <td class="parameter_description"><p>(gss_name_t, modify) The name to be deleted.</p></td>
2663 <td class="parameter_annotations"> </td>
2664 </tr>
2665 </tbody>
2666 </table></div>
2667 </div>
2668 <div class="refsect3">
2669 <a name="gss-release-name.returns"></a><h4>Returns</h4>
2670 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2671 <p><code class="literal">GSS_S_BAD_NAME</code>: The name parameter did not contain a valid name.</p>
2672 </div>
2673 </div>
2674 <hr>
2675 <div class="refsect2">
2676 <a name="gss-release-buffer"></a><h3>gss_release_buffer ()</h3>
2677 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2678 gss_release_buffer (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2679 <em class="parameter"><code><span class="type">gss_buffer_t</span> buffer</code></em>);</pre>
2680 <p>Free storage associated with a buffer. The storage must have been
2681 allocated by a GSS-API routine. In addition to freeing the
2682 associated storage, the routine will zero the length field in the
2683 descriptor to which the buffer parameter refers, and
2684 implementations are encouraged to additionally set the pointer
2685 field in the descriptor to NULL. Any buffer object returned by a
2686 GSS-API routine may be passed to gss_release_buffer (even if there
2687 is no storage associated with the buffer).</p>
2688 <div class="refsect3">
2689 <a name="gss-release-buffer.parameters"></a><h4>Parameters</h4>
2690 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2691 <colgroup>
2692 <col width="150px" class="parameters_name">
2693 <col class="parameters_description">
2694 <col width="200px" class="parameters_annotations">
2695 </colgroup>
2696 <tbody>
2697 <tr>
2698 <td class="parameter_name"><p>minor_status</p></td>
2699 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
2700 <td class="parameter_annotations"> </td>
2701 </tr>
2702 <tr>
2703 <td class="parameter_name"><p>buffer</p></td>
2704 <td class="parameter_description"><p>(buffer, modify) The storage associated with the buffer
2705 will be deleted. The gss_buffer_desc object will not be freed,
2706 but its length field will be zeroed.</p></td>
2707 <td class="parameter_annotations"> </td>
2708 </tr>
2709 </tbody>
2710 </table></div>
2711 </div>
2712 <div class="refsect3">
2713 <a name="gss-release-buffer.returns"></a><h4>Returns</h4>
2714 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2715 </div>
2716 </div>
2717 <hr>
2718 <div class="refsect2">
2719 <a name="gss-release-oid-set"></a><h3>gss_release_oid_set ()</h3>
2720 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2721 gss_release_oid_set (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2722 <em class="parameter"><code><span class="type">gss_OID_set</span> *set</code></em>);</pre>
2723 <p>Free storage associated with a GSSAPI-generated gss_OID_set object.
2724 The set parameter must refer to an OID-set that was returned from a
2725 GSS-API routine. <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a> will free the storage
2726 associated with each individual member OID, the OID set's elements
2727 array, and the gss_OID_set_desc.</p>
2728 <p>The gss_OID_set parameter is set to GSS_C_NO_OID_SET on successful
2729 completion of this routine.</p>
2730 <div class="refsect3">
2731 <a name="gss-release-oid-set.parameters"></a><h4>Parameters</h4>
2732 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2733 <colgroup>
2734 <col width="150px" class="parameters_name">
2735 <col class="parameters_description">
2736 <col width="200px" class="parameters_annotations">
2737 </colgroup>
2738 <tbody>
2739 <tr>
2740 <td class="parameter_name"><p>minor_status</p></td>
2741 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
2742 <td class="parameter_annotations"> </td>
2743 </tr>
2744 <tr>
2745 <td class="parameter_name"><p>set</p></td>
2746 <td class="parameter_description"><p>(Set of Object IDs, modify) The storage associated with the
2747 gss_OID_set will be deleted.</p></td>
2748 <td class="parameter_annotations"> </td>
2749 </tr>
2750 </tbody>
2751 </table></div>
2752 </div>
2753 <div class="refsect3">
2754 <a name="gss-release-oid-set.returns"></a><h4>Returns</h4>
2755 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2756 </div>
2757 </div>
2758 <hr>
2759 <div class="refsect2">
2760 <a name="gss-inquire-cred"></a><h3>gss_inquire_cred ()</h3>
2761 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2762 gss_inquire_cred (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2763 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> cred_handle</code></em>,
2764 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *name</code></em>,
2765 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *lifetime</code></em>,
2766 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-usage-t" title="gss_cred_usage_t"><span class="type">gss_cred_usage_t</span></a> *cred_usage</code></em>,
2767 <em class="parameter"><code><span class="type">gss_OID_set</span> *mechanisms</code></em>);</pre>
2768 <p>Obtains information about a credential.</p>
2769 <div class="refsect3">
2770 <a name="gss-inquire-cred.parameters"></a><h4>Parameters</h4>
2771 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2772 <colgroup>
2773 <col width="150px" class="parameters_name">
2774 <col class="parameters_description">
2775 <col width="200px" class="parameters_annotations">
2776 </colgroup>
2777 <tbody>
2778 <tr>
2779 <td class="parameter_name"><p>minor_status</p></td>
2780 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
2781 <td class="parameter_annotations"> </td>
2782 </tr>
2783 <tr>
2784 <td class="parameter_name"><p>cred_handle</p></td>
2785 <td class="parameter_description"><p>(gss_cred_id_t, read) A handle that refers to the
2786 target credential. Specify GSS_C_NO_CREDENTIAL to inquire about
2787 the default initiator principal.</p></td>
2788 <td class="parameter_annotations"> </td>
2789 </tr>
2790 <tr>
2791 <td class="parameter_name"><p>name</p></td>
2792 <td class="parameter_description"><p>(gss_name_t, modify, optional) The name whose identity the
2793 credential asserts. Storage associated with this name should be
2794 freed by the application after use with a call to
2795 <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>. Specify NULL if not required.</p></td>
2796 <td class="parameter_annotations"> </td>
2797 </tr>
2798 <tr>
2799 <td class="parameter_name"><p>lifetime</p></td>
2800 <td class="parameter_description"><p>(Integer, modify, optional) The number of seconds for
2801 which the credential will remain valid. If the credential has
2802 expired, this parameter will be set to zero. If the
2803 implementation does not support credential expiration, the value
2804 GSS_C_INDEFINITE will be returned. Specify NULL if not required.</p></td>
2805 <td class="parameter_annotations"> </td>
2806 </tr>
2807 <tr>
2808 <td class="parameter_name"><p>cred_usage</p></td>
2809 <td class="parameter_description"><p>(gss_cred_usage_t, modify, optional) How the
2810 credential may be used. One of the following: GSS_C_INITIATE,
2811 GSS_C_ACCEPT, GSS_C_BOTH. Specify NULL if not required.</p></td>
2812 <td class="parameter_annotations"> </td>
2813 </tr>
2814 <tr>
2815 <td class="parameter_name"><p>mechanisms</p></td>
2816 <td class="parameter_description"><p>(gss_OID_set, modify, optional) Set of mechanisms
2817 supported by the credential. Storage associated with this OID
2818 set must be freed by the application after use with a call to
2819 <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>. Specify NULL if not required.</p></td>
2820 <td class="parameter_annotations"> </td>
2821 </tr>
2822 </tbody>
2823 </table></div>
2824 </div>
2825 <div class="refsect3">
2826 <a name="gss-inquire-cred.returns"></a><h4>Returns</h4>
2827 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
2828 <p><code class="literal">GSS_S_NO_CRED</code>: The referenced credentials could not be accessed.</p>
2829 <p><code class="literal">GSS_S_DEFECTIVE_CREDENTIAL</code>: The referenced credentials were invalid.</p>
2830 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The referenced credentials have
2831 expired. If the lifetime parameter was not passed as NULL, it will
2832 be set to 0.</p>
2833 </div>
2834 </div>
2835 <hr>
2836 <div class="refsect2">
2837 <a name="gss-inquire-context"></a><h3>gss_inquire_context ()</h3>
2838 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
2839 gss_inquire_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
2840 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
2841 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *src_name</code></em>,
2842 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *targ_name</code></em>,
2843 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *lifetime_rec</code></em>,
2844 <em class="parameter"><code><span class="type">gss_OID</span> *mech_type</code></em>,
2845 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *ctx_flags</code></em>,
2846 <em class="parameter"><code><span class="type">int</span> *locally_initiated</code></em>,
2847 <em class="parameter"><code><span class="type">int</span> *open</code></em>);</pre>
2848 <p>Obtains information about a security context. The caller must
2849 already have obtained a handle that refers to the context, although
2850 the context need not be fully established.</p>
2851 <p>The <code class="literal">ctx_flags</code> values:</p>
2852 <p><code class="literal">GSS_C_DELEG_FLAG</code>::</p>
2853 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2854 <li class="listitem"><p>True - Credentials were delegated from the initiator to the
2855 acceptor.</p></li>
2856 <li class="listitem"><p>False - No credentials were delegated.</p></li>
2857 </ul></div>
2858 <p><code class="literal">GSS_C_MUTUAL_FLAG</code>::</p>
2859 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2860 <li class="listitem"><p>True - The acceptor was authenticated to the initiator.</p></li>
2861 <li class="listitem"><p>False - The acceptor did not authenticate itself.</p></li>
2862 </ul></div>
2863 <p><code class="literal">GSS_C_REPLAY_FLAG</code>::</p>
2864 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2865 <li class="listitem"><p>True - replay of protected messages will be detected.</p></li>
2866 <li class="listitem"><p>False - replayed messages will not be detected.</p></li>
2867 </ul></div>
2868 <p><code class="literal">GSS_C_SEQUENCE_FLAG</code>::</p>
2869 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2870 <li class="listitem"><p>True - out-of-sequence protected messages will be detected.</p></li>
2871 <li class="listitem"><p>False - out-of-sequence messages will not be detected.</p></li>
2872 </ul></div>
2873 <p><code class="literal">GSS_C_CONF_FLAG</code>::</p>
2874 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2875 <li class="listitem"><p>True - Confidentiality service may be invoked by calling gss_wrap
2876 routine.</p></li>
2877 <li class="listitem"><p>False - No confidentiality service (via gss_wrap)
2878 available. gss_wrap will provide message encapsulation, data-origin
2879 authentication and integrity services only.</p></li>
2880 </ul></div>
2881 <p><code class="literal">GSS_C_INTEG_FLAG</code>::</p>
2882 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2883 <li class="listitem"><p>True - Integrity service may be invoked by calling either
2884 gss_get_mic or gss_wrap routines.</p></li>
2885 <li class="listitem"><p>False - Per-message integrity service unavailable.</p></li>
2886 </ul></div>
2887 <p><code class="literal">GSS_C_ANON_FLAG</code>::</p>
2888 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2889 <li class="listitem"><p>True - The initiator's identity will not be revealed to the
2890 acceptor. The src_name parameter (if requested) contains an
2891 anonymous internal name.</p></li>
2892 <li class="listitem"><p>False - The initiator has been authenticated normally.</p></li>
2893 </ul></div>
2894 <p><code class="literal">GSS_C_PROT_READY_FLAG</code>::</p>
2895 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2896 <li class="listitem"><p>True - Protection services (as specified by the states of the
2897 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available for use.</p></li>
2898 <li class="listitem"><p>False - Protection services (as specified by the states of the
2899 GSS_C_CONF_FLAG and GSS_C_INTEG_FLAG) are available only if the
2900 context is fully established (i.e. if the open parameter is
2901 non-zero).</p></li>
2902 </ul></div>
2903 <p><code class="literal">GSS_C_TRANS_FLAG</code>::</p>
2904 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2905 <li class="listitem"><p>True - The resultant security context may be transferred to other
2906 processes via a call to <a class="link" href="gss-api.html#gss-export-sec-context" title="gss_export_sec_context ()"><code class="function">gss_export_sec_context()</code></a>.</p></li>
2907 <li class="listitem"><p>False - The security context is not transferable.</p></li>
2908 </ul></div>
2909 <div class="refsect3">
2910 <a name="gss-inquire-context.parameters"></a><h4>Parameters</h4>
2911 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2912 <colgroup>
2913 <col width="150px" class="parameters_name">
2914 <col class="parameters_description">
2915 <col width="200px" class="parameters_annotations">
2916 </colgroup>
2917 <tbody>
2918 <tr>
2919 <td class="parameter_name"><p>minor_status</p></td>
2920 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
2921 <td class="parameter_annotations"> </td>
2922 </tr>
2923 <tr>
2924 <td class="parameter_name"><p>context_handle</p></td>
2925 <td class="parameter_description"><p>(gss_ctx_id_t, read) A handle that refers to the
2926 security context.</p></td>
2927 <td class="parameter_annotations"> </td>
2928 </tr>
2929 <tr>
2930 <td class="parameter_name"><p>src_name</p></td>
2931 <td class="parameter_description"><p>(gss_name_t, modify, optional) The name of the context
2932 initiator. If the context was established using anonymous
2933 authentication, and if the application invoking
2934 gss_inquire_context is the context acceptor, an anonymous name
2935 will be returned. Storage associated with this name must be
2936 freed by the application after use with a call to
2937 <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>. Specify NULL if not required.</p></td>
2938 <td class="parameter_annotations"> </td>
2939 </tr>
2940 <tr>
2941 <td class="parameter_name"><p>targ_name</p></td>
2942 <td class="parameter_description"><p>(gss_name_t, modify, optional) The name of the context
2943 acceptor. Storage associated with this name must be freed by the
2944 application after use with a call to <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>. If the
2945 context acceptor did not authenticate itself, and if the
2946 initiator did not specify a target name in its call to
2947 <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a>, the value GSS_C_NO_NAME will be returned.
2948 Specify NULL if not required.</p></td>
2949 <td class="parameter_annotations"> </td>
2950 </tr>
2951 <tr>
2952 <td class="parameter_name"><p>lifetime_rec</p></td>
2953 <td class="parameter_description"><p>(Integer, modify, optional) The number of seconds
2954 for which the context will remain valid. If the context has
2955 expired, this parameter will be set to zero. If the
2956 implementation does not support context expiration, the value
2957 GSS_C_INDEFINITE will be returned. Specify NULL if not required.</p></td>
2958 <td class="parameter_annotations"> </td>
2959 </tr>
2960 <tr>
2961 <td class="parameter_name"><p>mech_type</p></td>
2962 <td class="parameter_description"><p>(gss_OID, modify, optional) The security mechanism
2963 providing the context. The returned OID will be a pointer to
2964 static storage that should be treated as read-only by the
2965 application; in particular the application should not attempt to
2966 free it. Specify NULL if not required.</p></td>
2967 <td class="parameter_annotations"> </td>
2968 </tr>
2969 <tr>
2970 <td class="parameter_name"><p>ctx_flags</p></td>
2971 <td class="parameter_description"><p>(bit-mask, modify, optional) Contains various
2972 independent flags, each of which indicates that the context
2973 supports (or is expected to support, if ctx_open is false) a
2974 specific service option. If not needed, specify NULL. Symbolic
2975 names are provided for each flag, and the symbolic names
2976 corresponding to the required flags should be logically-ANDed
2977 with the ret_flags value to test whether a given option is
2978 supported by the context. See below for the flags.</p></td>
2979 <td class="parameter_annotations"> </td>
2980 </tr>
2981 <tr>
2982 <td class="parameter_name"><p>locally_initiated</p></td>
2983 <td class="parameter_description"><p>(Boolean, modify) Non-zero if the invoking
2984 application is the context initiator. Specify NULL if not
2985 required.</p></td>
2986 <td class="parameter_annotations"> </td>
2987 </tr>
2988 <tr>
2989 <td class="parameter_name"><p>open</p></td>
2990 <td class="parameter_description"><p>(Boolean, modify) Non-zero if the context is fully
2991 established; Zero if a context-establishment token is expected
2992 from the peer application. Specify NULL if not required.</p></td>
2993 <td class="parameter_annotations"> </td>
2994 </tr>
2995 </tbody>
2996 </table></div>
2997 </div>
2998 <div class="refsect3">
2999 <a name="gss-inquire-context.returns"></a><h4>Returns</h4>
3000 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3001 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The referenced context could not be accessed.</p>
3002 </div>
3003 </div>
3004 <hr>
3005 <div class="refsect2">
3006 <a name="gss-wrap-size-limit"></a><h3>gss_wrap_size_limit ()</h3>
3007 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3008 gss_wrap_size_limit (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3009 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
3010 <em class="parameter"><code><span class="type">int</span> conf_req_flag</code></em>,
3011 <em class="parameter"><code><a class="link" href="gss-api.html#gss-qop-t" title="gss_qop_t"><span class="type">gss_qop_t</span></a> qop_req</code></em>,
3012 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> req_output_size</code></em>,
3013 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *max_input_size</code></em>);</pre>
3014 <p>Allows an application to determine the maximum message size that,
3015 if presented to gss_wrap with the same conf_req_flag and qop_req
3016 parameters, will result in an output token containing no more than
3017 req_output_size bytes.</p>
3018 <p>This call is intended for use by applications that communicate over
3019 protocols that impose a maximum message size. It enables the
3020 application to fragment messages prior to applying protection.</p>
3021 <p>GSS-API implementations are recommended but not required to detect
3022 invalid QOP values when <a class="link" href="gss-api.html#gss-wrap-size-limit" title="gss_wrap_size_limit ()"><code class="function">gss_wrap_size_limit()</code></a> is called. This
3023 routine guarantees only a maximum message size, not the
3024 availability of specific QOP values for message protection.</p>
3025 <p>Successful completion of this call does not guarantee that gss_wrap
3026 will be able to protect a message of length max_input_size bytes,
3027 since this ability may depend on the availability of system
3028 resources at the time that gss_wrap is called. However, if the
3029 implementation itself imposes an upper limit on the length of
3030 messages that may be processed by gss_wrap, the implementation
3031 should not return a value via max_input_bytes that is greater than
3032 this length.</p>
3033 <div class="refsect3">
3034 <a name="gss-wrap-size-limit.parameters"></a><h4>Parameters</h4>
3035 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3036 <colgroup>
3037 <col width="150px" class="parameters_name">
3038 <col class="parameters_description">
3039 <col width="200px" class="parameters_annotations">
3040 </colgroup>
3041 <tbody>
3042 <tr>
3043 <td class="parameter_name"><p>minor_status</p></td>
3044 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3045 <td class="parameter_annotations"> </td>
3046 </tr>
3047 <tr>
3048 <td class="parameter_name"><p>context_handle</p></td>
3049 <td class="parameter_description"><p>(gss_ctx_id_t, read) A handle that refers to the
3050 security over which the messages will be sent.</p></td>
3051 <td class="parameter_annotations"> </td>
3052 </tr>
3053 <tr>
3054 <td class="parameter_name"><p>conf_req_flag</p></td>
3055 <td class="parameter_description"><p>(Boolean, read) Indicates whether gss_wrap will be
3056 asked to apply confidentiality protection in addition to
3057 integrity protection. See the routine description for gss_wrap
3058 for more details.</p></td>
3059 <td class="parameter_annotations"> </td>
3060 </tr>
3061 <tr>
3062 <td class="parameter_name"><p>qop_req</p></td>
3063 <td class="parameter_description"><p>(gss_qop_t, read) Indicates the level of protection that
3064 gss_wrap will be asked to provide. See the routine description
3065 for gss_wrap for more details.</p></td>
3066 <td class="parameter_annotations"> </td>
3067 </tr>
3068 <tr>
3069 <td class="parameter_name"><p>req_output_size</p></td>
3070 <td class="parameter_description"><p>(Integer, read) The desired maximum size for
3071 tokens emitted by gss_wrap.</p></td>
3072 <td class="parameter_annotations"> </td>
3073 </tr>
3074 <tr>
3075 <td class="parameter_name"><p>max_input_size</p></td>
3076 <td class="parameter_description"><p>(Integer, modify) The maximum input message size
3077 that may be presented to gss_wrap in order to guarantee that the
3078 emitted token shall be no larger than req_output_size bytes.</p></td>
3079 <td class="parameter_annotations"> </td>
3080 </tr>
3081 </tbody>
3082 </table></div>
3083 </div>
3084 <div class="refsect3">
3085 <a name="gss-wrap-size-limit.returns"></a><h4>Returns</h4>
3086 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3087 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The referenced context could not be accessed.</p>
3088 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has expired.</p>
3089 <p><code class="literal">GSS_S_BAD_QOP</code>: The specified QOP is not supported by the
3090 mechanism.</p>
3091 </div>
3092 </div>
3093 <hr>
3094 <div class="refsect2">
3095 <a name="gss-add-cred"></a><h3>gss_add_cred ()</h3>
3096 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3097 gss_add_cred (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3098 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> input_cred_handle</code></em>,
3099 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> desired_name</code></em>,
3100 <em class="parameter"><code>const <span class="type">gss_OID</span> desired_mech</code></em>,
3101 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-usage-t" title="gss_cred_usage_t"><span class="type">gss_cred_usage_t</span></a> cred_usage</code></em>,
3102 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> initiator_time_req</code></em>,
3103 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> acceptor_time_req</code></em>,
3104 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> *output_cred_handle</code></em>,
3105 <em class="parameter"><code><span class="type">gss_OID_set</span> *actual_mechs</code></em>,
3106 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *initiator_time_rec</code></em>,
3107 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *acceptor_time_rec</code></em>);</pre>
3108 <p>Adds a credential-element to a credential. The credential-element is
3109 identified by the name of the principal to which it refers. GSS-API
3110 implementations must impose a local access-control policy on callers
3111 of this routine to prevent unauthorized callers from acquiring
3112 credential-elements to which they are not entitled. This routine is
3113 not intended to provide a "login to the network" function, as such a
3114 function would involve the creation of new mechanism-specific
3115 authentication data, rather than merely acquiring a GSS-API handle to
3116 existing data. Such functions, if required, should be defined in
3117 implementation-specific extensions to the API.</p>
3118 <p>If desired_name is GSS_C_NO_NAME, the call is interpreted as a
3119 request to add a credential element that will invoke default behavior
3120 when passed to <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a> (if cred_usage is
3121 GSS_C_INITIATE or GSS_C_BOTH) or <a class="link" href="gss-api.html#gss-accept-sec-context" title="gss_accept_sec_context ()"><code class="function">gss_accept_sec_context()</code></a> (if
3122 cred_usage is GSS_C_ACCEPT or GSS_C_BOTH).</p>
3123 <p>This routine is expected to be used primarily by context acceptors,
3124 since implementations are likely to provide mechanism-specific ways
3125 of obtaining GSS-API initiator credentials from the system login
3126 process. Some implementations may therefore not support the
3127 acquisition of GSS_C_INITIATE or GSS_C_BOTH credentials via
3128 gss_acquire_cred for any name other than GSS_C_NO_NAME, or a name
3129 produced by applying either gss_inquire_cred to a valid credential,
3130 or gss_inquire_context to an active context.</p>
3131 <p>If credential acquisition is time-consuming for a mechanism, the
3132 mechanism may choose to delay the actual acquisition until the
3133 credential is required (e.g. by gss_init_sec_context or
3134 gss_accept_sec_context). Such mechanism-specific implementation
3135 decisions should be invisible to the calling application; thus a call
3136 of gss_inquire_cred immediately following the call of gss_add_cred
3137 must return valid credential data, and may therefore incur the
3138 overhead of a deferred credential acquisition.</p>
3139 <p>This routine can be used to either compose a new credential
3140 containing all credential-elements of the original in addition to the
3141 newly-acquire credential-element, or to add the new credential-
3142 element to an existing credential. If NULL is specified for the
3143 output_cred_handle parameter argument, the new credential-element
3144 will be added to the credential identified by input_cred_handle; if a
3145 valid pointer is specified for the output_cred_handle parameter, a
3146 new credential handle will be created.</p>
3147 <p>If GSS_C_NO_CREDENTIAL is specified as the input_cred_handle,
3148 gss_add_cred will compose a credential (and set the
3149 output_cred_handle parameter accordingly) based on default behavior.
3150 That is, the call will have the same effect as if the application had
3151 first made a call to <a class="link" href="gss-api.html#gss-acquire-cred" title="gss_acquire_cred ()"><code class="function">gss_acquire_cred()</code></a>, specifying the same usage
3152 and passing GSS_C_NO_NAME as the desired_name parameter to obtain an
3153 explicit credential handle embodying default behavior, passed this
3154 credential handle to <a class="link" href="gss-api.html#gss-add-cred" title="gss_add_cred ()"><code class="function">gss_add_cred()</code></a>, and finally called
3155 <a class="link" href="gss-api.html#gss-release-cred" title="gss_release_cred ()"><code class="function">gss_release_cred()</code></a> on the first credential handle.</p>
3156 <p>If GSS_C_NO_CREDENTIAL is specified as the input_cred_handle
3157 parameter, a non-NULL output_cred_handle must be supplied.</p>
3158 <div class="refsect3">
3159 <a name="gss-add-cred.parameters"></a><h4>Parameters</h4>
3160 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3161 <colgroup>
3162 <col width="150px" class="parameters_name">
3163 <col class="parameters_description">
3164 <col width="200px" class="parameters_annotations">
3165 </colgroup>
3166 <tbody>
3167 <tr>
3168 <td class="parameter_name"><p>minor_status</p></td>
3169 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
3170 <td class="parameter_annotations"> </td>
3171 </tr>
3172 <tr>
3173 <td class="parameter_name"><p>input_cred_handle</p></td>
3174 <td class="parameter_description"><p>(gss_cred_id_t, read, optional) The credential
3175 to which a credential-element will be added. If
3176 GSS_C_NO_CREDENTIAL is specified, the routine will compose the
3177 new credential based on default behavior (see text).
3178 Note that, while the credential-handle is not modified by
3179 <a class="link" href="gss-api.html#gss-add-cred" title="gss_add_cred ()"><code class="function">gss_add_cred()</code></a>, the underlying credential will be modified if
3180 output_credential_handle is NULL.</p></td>
3181 <td class="parameter_annotations"> </td>
3182 </tr>
3183 <tr>
3184 <td class="parameter_name"><p>desired_name</p></td>
3185 <td class="parameter_description"><p>(gss_name_t, read.) Name of principal whose
3186 credential should be acquired.</p></td>
3187 <td class="parameter_annotations"> </td>
3188 </tr>
3189 <tr>
3190 <td class="parameter_name"><p>desired_mech</p></td>
3191 <td class="parameter_description"><p>(Object ID, read) Underlying security mechanism with
3192 which the credential may be used.</p></td>
3193 <td class="parameter_annotations"> </td>
3194 </tr>
3195 <tr>
3196 <td class="parameter_name"><p>cred_usage</p></td>
3197 <td class="parameter_description"><p>(gss_cred_usage_t, read) GSS_C_BOTH - Credential may
3198 be used either to initiate or accept security contexts.
3199 GSS_C_INITIATE - Credential will only be used to initiate
3200 security contexts. GSS_C_ACCEPT - Credential will only be used
3201 to accept security contexts.</p></td>
3202 <td class="parameter_annotations"> </td>
3203 </tr>
3204 <tr>
3205 <td class="parameter_name"><p>initiator_time_req</p></td>
3206 <td class="parameter_description"><p>(Integer, read, optional) number of seconds
3207 that the credential should remain valid for initiating security
3208 contexts. This argument is ignored if the composed credentials
3209 are of type GSS_C_ACCEPT. Specify GSS_C_INDEFINITE to request
3210 that the credentials have the maximum permitted initiator
3211 lifetime.</p></td>
3212 <td class="parameter_annotations"> </td>
3213 </tr>
3214 <tr>
3215 <td class="parameter_name"><p>acceptor_time_req</p></td>
3216 <td class="parameter_description"><p>(Integer, read, optional) number of seconds
3217 that the credential should remain valid for accepting security
3218 contexts. This argument is ignored if the composed credentials
3219 are of type GSS_C_INITIATE. Specify GSS_C_INDEFINITE to request
3220 that the credentials have the maximum permitted initiator
3221 lifetime.</p></td>
3222 <td class="parameter_annotations"> </td>
3223 </tr>
3224 <tr>
3225 <td class="parameter_name"><p>output_cred_handle</p></td>
3226 <td class="parameter_description"><p>(gss_cred_id_t, modify, optional) The returned
3227 credential handle, containing the new credential-element and all
3228 the credential-elements from input_cred_handle. If a valid
3229 pointer to a gss_cred_id_t is supplied for this parameter,
3230 gss_add_cred creates a new credential handle containing all
3231 credential-elements from the input_cred_handle and the newly
3232 acquired credential-element; if NULL is specified for this
3233 parameter, the newly acquired credential-element will be added to
3234 the credential identified by input_cred_handle. The resources
3235 associated with any credential handle returned via this parameter
3236 must be released by the application after use with a call to
3237 <a class="link" href="gss-api.html#gss-release-cred" title="gss_release_cred ()"><code class="function">gss_release_cred()</code></a>.</p></td>
3238 <td class="parameter_annotations"> </td>
3239 </tr>
3240 <tr>
3241 <td class="parameter_name"><p>actual_mechs</p></td>
3242 <td class="parameter_description"><p>(Set of Object IDs, modify, optional) The complete
3243 set of mechanisms for which the new credential is valid. Storage
3244 for the returned OID-set must be freed by the application after
3245 use with a call to <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>. Specify NULL if not
3246 required.</p></td>
3247 <td class="parameter_annotations"> </td>
3248 </tr>
3249 <tr>
3250 <td class="parameter_name"><p>initiator_time_rec</p></td>
3251 <td class="parameter_description"><p>(Integer, modify, optional) Actual number of
3252 seconds for which the returned credentials will remain valid for
3253 initiating contexts using the specified mechanism. If the
3254 implementation or mechanism does not support expiration of
3255 credentials, the value GSS_C_INDEFINITE will be returned. Specify
3256 NULL if not required</p></td>
3257 <td class="parameter_annotations"> </td>
3258 </tr>
3259 <tr>
3260 <td class="parameter_name"><p>acceptor_time_rec</p></td>
3261 <td class="parameter_description"><p>(Integer, modify, optional) Actual number of
3262 seconds for which the returned credentials will remain valid for
3263 accepting security contexts using the specified mechanism. If
3264 the implementation or mechanism does not support expiration of
3265 credentials, the value GSS_C_INDEFINITE will be returned. Specify
3266 NULL if not required</p></td>
3267 <td class="parameter_annotations"> </td>
3268 </tr>
3269 </tbody>
3270 </table></div>
3271 </div>
3272 <div class="refsect3">
3273 <a name="gss-add-cred.returns"></a><h4>Returns</h4>
3274 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3275 <p><code class="literal">GSS_S_BAD_MECH</code>: Unavailable mechanism requested.</p>
3276 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: Type contained within desired_name parameter
3277 is not supported.</p>
3278 <p><code class="literal">GSS_S_BAD_NAME</code>: Value supplied for desired_name parameter is
3279 ill-formed.</p>
3280 <p><code class="literal">GSS_S_DUPLICATE_ELEMENT</code>: The credential already contains an
3281 element for the requested mechanism with overlapping usage and
3282 validity period.</p>
3283 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The required credentials could not be
3284 added because they have expired.</p>
3285 <p><code class="literal">GSS_S_NO_CRED</code>: No credentials were found for the specified name.</p>
3286 </div>
3287 </div>
3288 <hr>
3289 <div class="refsect2">
3290 <a name="gss-inquire-cred-by-mech"></a><h3>gss_inquire_cred_by_mech ()</h3>
3291 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3292 gss_inquire_cred_by_mech (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3293 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-cred-id-t" title="gss_cred_id_t"><span class="type">gss_cred_id_t</span></a> cred_handle</code></em>,
3294 <em class="parameter"><code>const <span class="type">gss_OID</span> mech_type</code></em>,
3295 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *name</code></em>,
3296 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *initiator_lifetime</code></em>,
3297 <em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *acceptor_lifetime</code></em>,
3298 <em class="parameter"><code><a class="link" href="gss-api.html#gss-cred-usage-t" title="gss_cred_usage_t"><span class="type">gss_cred_usage_t</span></a> *cred_usage</code></em>);</pre>
3299 <p>Obtains per-mechanism information about a credential.</p>
3300 <div class="refsect3">
3301 <a name="gss-inquire-cred-by-mech.parameters"></a><h4>Parameters</h4>
3302 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3303 <colgroup>
3304 <col width="150px" class="parameters_name">
3305 <col class="parameters_description">
3306 <col width="200px" class="parameters_annotations">
3307 </colgroup>
3308 <tbody>
3309 <tr>
3310 <td class="parameter_name"><p>minor_status</p></td>
3311 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3312 <td class="parameter_annotations"> </td>
3313 </tr>
3314 <tr>
3315 <td class="parameter_name"><p>cred_handle</p></td>
3316 <td class="parameter_description"><p>(gss_cred_id_t, read) A handle that refers to the
3317 target credential. Specify GSS_C_NO_CREDENTIAL to inquire about
3318 the default initiator principal.</p></td>
3319 <td class="parameter_annotations"> </td>
3320 </tr>
3321 <tr>
3322 <td class="parameter_name"><p>mech_type</p></td>
3323 <td class="parameter_description"><p>(gss_OID, read) The mechanism for which information
3324 should be returned.</p></td>
3325 <td class="parameter_annotations"> </td>
3326 </tr>
3327 <tr>
3328 <td class="parameter_name"><p>name</p></td>
3329 <td class="parameter_description"><p>(gss_name_t, modify, optional) The name whose identity the
3330 credential asserts. Storage associated with this name must be
3331 freed by the application after use with a call to
3332 <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>. Specify NULL if not required.</p></td>
3333 <td class="parameter_annotations"> </td>
3334 </tr>
3335 <tr>
3336 <td class="parameter_name"><p>initiator_lifetime</p></td>
3337 <td class="parameter_description"><p>(Integer, modify, optional) The number of
3338 seconds for which the credential will remain capable of
3339 initiating security contexts under the specified mechanism. If
3340 the credential can no longer be used to initiate contexts, or if
3341 the credential usage for this mechanism is GSS_C_ACCEPT, this
3342 parameter will be set to zero. If the implementation does not
3343 support expiration of initiator credentials, the value
3344 GSS_C_INDEFINITE will be returned. Specify NULL if not required.</p></td>
3345 <td class="parameter_annotations"> </td>
3346 </tr>
3347 <tr>
3348 <td class="parameter_name"><p>acceptor_lifetime</p></td>
3349 <td class="parameter_description"><p>(Integer, modify, optional) The number of
3350 seconds for which the credential will remain capable of accepting
3351 security contexts under the specified mechanism. If the
3352 credential can no longer be used to accept contexts, or if the
3353 credential usage for this mechanism is GSS_C_INITIATE, this
3354 parameter will be set to zero. If the implementation does not
3355 support expiration of acceptor credentials, the value
3356 GSS_C_INDEFINITE will be returned. Specify NULL if not required.</p></td>
3357 <td class="parameter_annotations"> </td>
3358 </tr>
3359 <tr>
3360 <td class="parameter_name"><p>cred_usage</p></td>
3361 <td class="parameter_description"><p>(gss_cred_usage_t, modify, optional) How the
3362 credential may be used with the specified mechanism. One of the
3363 following: GSS_C_INITIATE, GSS_C_ACCEPT, GSS_C_BOTH. Specify NULL
3364 if not required.</p></td>
3365 <td class="parameter_annotations"> </td>
3366 </tr>
3367 </tbody>
3368 </table></div>
3369 </div>
3370 <div class="refsect3">
3371 <a name="gss-inquire-cred-by-mech.returns"></a><h4>Returns</h4>
3372 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3373 <p><code class="literal">GSS_S_NO_CRED</code>: The referenced credentials could not be accessed.</p>
3374 <p><code class="literal">GSS_S_DEFECTIVE_CREDENTIAL</code>: The referenced credentials were invalid.</p>
3375 <p><code class="literal">GSS_S_CREDENTIALS_EXPIRED</code>: The referenced credentials have
3376 expired. If the lifetime parameter was not passed as NULL, it will
3377 be set to 0.</p>
3378 </div>
3379 </div>
3380 <hr>
3381 <div class="refsect2">
3382 <a name="gss-export-sec-context"></a><h3>gss_export_sec_context ()</h3>
3383 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3384 gss_export_sec_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3385 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> *context_handle</code></em>,
3386 <em class="parameter"><code><span class="type">gss_buffer_t</span> interprocess_token</code></em>);</pre>
3387 <p>Provided to support the sharing of work between multiple processes.
3388 This routine will typically be used by the context-acceptor, in an
3389 application where a single process receives incoming connection
3390 requests and accepts security contexts over them, then passes the
3391 established context to one or more other processes for message
3392 exchange. <a class="link" href="gss-api.html#gss-export-sec-context" title="gss_export_sec_context ()"><code class="function">gss_export_sec_context()</code></a> deactivates the security context
3393 for the calling process and creates an interprocess token which,
3394 when passed to gss_import_sec_context in another process, will
3395 re-activate the context in the second process. Only a single
3396 instantiation of a given context may be active at any one time; a
3397 subsequent attempt by a context exporter to access the exported
3398 security context will fail.</p>
3399 <p>The implementation may constrain the set of processes by which the
3400 interprocess token may be imported, either as a function of local
3401 security policy, or as a result of implementation decisions. For
3402 example, some implementations may constrain contexts to be passed
3403 only between processes that run under the same account, or which
3404 are part of the same process group.</p>
3405 <p>The interprocess token may contain security-sensitive information
3406 (for example cryptographic keys). While mechanisms are encouraged
3407 to either avoid placing such sensitive information within
3408 interprocess tokens, or to encrypt the token before returning it to
3409 the application, in a typical object-library GSS-API implementation
3410 this may not be possible. Thus the application must take care to
3411 protect the interprocess token, and ensure that any process to
3412 which the token is transferred is trustworthy.</p>
3413 <p>If creation of the interprocess token is successful, the
3414 implementation shall deallocate all process-wide resources
3415 associated with the security context, and set the context_handle to
3416 GSS_C_NO_CONTEXT. In the event of an error that makes it
3417 impossible to complete the export of the security context, the
3418 implementation must not return an interprocess token, and should
3419 strive to leave the security context referenced by the
3420 context_handle parameter untouched. If this is impossible, it is
3421 permissible for the implementation to delete the security context,
3422 providing it also sets the context_handle parameter to
3423 GSS_C_NO_CONTEXT.</p>
3424 <div class="refsect3">
3425 <a name="gss-export-sec-context.parameters"></a><h4>Parameters</h4>
3426 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3427 <colgroup>
3428 <col width="150px" class="parameters_name">
3429 <col class="parameters_description">
3430 <col width="200px" class="parameters_annotations">
3431 </colgroup>
3432 <tbody>
3433 <tr>
3434 <td class="parameter_name"><p>minor_status</p></td>
3435 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3436 <td class="parameter_annotations"> </td>
3437 </tr>
3438 <tr>
3439 <td class="parameter_name"><p>context_handle</p></td>
3440 <td class="parameter_description"><p>(gss_ctx_id_t, modify) Context handle identifying
3441 the context to transfer.</p></td>
3442 <td class="parameter_annotations"> </td>
3443 </tr>
3444 <tr>
3445 <td class="parameter_name"><p>interprocess_token</p></td>
3446 <td class="parameter_description"><p>(buffer, opaque, modify) Token to be
3447 transferred to target process. Storage associated with this
3448 token must be freed by the application after use with a call to
3449 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
3450 <td class="parameter_annotations"> </td>
3451 </tr>
3452 </tbody>
3453 </table></div>
3454 </div>
3455 <div class="refsect3">
3456 <a name="gss-export-sec-context.returns"></a><h4>Returns</h4>
3457 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3458 <p><code class="literal">GSS_S_CONTEXT_EXPIRED</code>: The context has expired.</p>
3459 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The context was invalid.</p>
3460 <p><code class="literal">GSS_S_UNAVAILABLE</code>: The operation is not supported.</p>
3461 </div>
3462 </div>
3463 <hr>
3464 <div class="refsect2">
3465 <a name="gss-import-sec-context"></a><h3>gss_import_sec_context ()</h3>
3466 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3467 gss_import_sec_context (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3468 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> interprocess_token</code></em>,
3469 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> *context_handle</code></em>);</pre>
3470 <p>Allows a process to import a security context established by
3471 another process. A given interprocess token may be imported only
3472 once. See gss_export_sec_context.</p>
3473 <div class="refsect3">
3474 <a name="gss-import-sec-context.parameters"></a><h4>Parameters</h4>
3475 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3476 <colgroup>
3477 <col width="150px" class="parameters_name">
3478 <col class="parameters_description">
3479 <col width="200px" class="parameters_annotations">
3480 </colgroup>
3481 <tbody>
3482 <tr>
3483 <td class="parameter_name"><p>minor_status</p></td>
3484 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3485 <td class="parameter_annotations"> </td>
3486 </tr>
3487 <tr>
3488 <td class="parameter_name"><p>interprocess_token</p></td>
3489 <td class="parameter_description"><p>(buffer, opaque, modify) Token received from
3490 exporting process</p></td>
3491 <td class="parameter_annotations"> </td>
3492 </tr>
3493 <tr>
3494 <td class="parameter_name"><p>context_handle</p></td>
3495 <td class="parameter_description"><p>(gss_ctx_id_t, modify) Context handle of newly
3496 reactivated context. Resources associated with this context
3497 handle must be released by the application after use with a call
3498 to <a class="link" href="gss-api.html#gss-delete-sec-context" title="gss_delete_sec_context ()"><code class="function">gss_delete_sec_context()</code></a>.</p></td>
3499 <td class="parameter_annotations"> </td>
3500 </tr>
3501 </tbody>
3502 </table></div>
3503 </div>
3504 <div class="refsect3">
3505 <a name="gss-import-sec-context.returns"></a><h4>Returns</h4>
3506 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3507 <p><code class="literal">GSS_S_NO_CONTEXT</code>: The token did not contain a valid context
3508 reference.</p>
3509 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: The token was invalid.</p>
3510 <p><code class="literal">GSS_S_UNAVAILABLE</code>: The operation is unavailable.</p>
3511 <p><code class="literal">GSS_S_UNAUTHORIZED</code>: Local policy prevents the import of this
3512 context by the current process.</p>
3513 </div>
3514 </div>
3515 <hr>
3516 <div class="refsect2">
3517 <a name="gss-create-empty-oid-set"></a><h3>gss_create_empty_oid_set ()</h3>
3518 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3519 gss_create_empty_oid_set (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3520 <em class="parameter"><code><span class="type">gss_OID_set</span> *oid_set</code></em>);</pre>
3521 <p>Create an object-identifier set containing no object identifiers,
3522 to which members may be subsequently added using the
3523 <a class="link" href="gss-api.html#gss-add-oid-set-member" title="gss_add_oid_set_member ()"><code class="function">gss_add_oid_set_member()</code></a> routine. These routines are intended to
3524 be used to construct sets of mechanism object identifiers, for
3525 input to gss_acquire_cred.</p>
3526 <div class="refsect3">
3527 <a name="gss-create-empty-oid-set.parameters"></a><h4>Parameters</h4>
3528 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3529 <colgroup>
3530 <col width="150px" class="parameters_name">
3531 <col class="parameters_description">
3532 <col width="200px" class="parameters_annotations">
3533 </colgroup>
3534 <tbody>
3535 <tr>
3536 <td class="parameter_name"><p>minor_status</p></td>
3537 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
3538 <td class="parameter_annotations"> </td>
3539 </tr>
3540 <tr>
3541 <td class="parameter_name"><p>oid_set</p></td>
3542 <td class="parameter_description"><p>(Set of Object IDs, modify) The empty object identifier
3543 set. The routine will allocate the gss_OID_set_desc object,
3544 which the application must free after use with a call to
3545 <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>.</p></td>
3546 <td class="parameter_annotations"> </td>
3547 </tr>
3548 </tbody>
3549 </table></div>
3550 </div>
3551 <div class="refsect3">
3552 <a name="gss-create-empty-oid-set.returns"></a><h4>Returns</h4>
3553 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3554 </div>
3555 </div>
3556 <hr>
3557 <div class="refsect2">
3558 <a name="gss-add-oid-set-member"></a><h3>gss_add_oid_set_member ()</h3>
3559 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3560 gss_add_oid_set_member (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3561 <em class="parameter"><code>const <span class="type">gss_OID</span> member_oid</code></em>,
3562 <em class="parameter"><code><span class="type">gss_OID_set</span> *oid_set</code></em>);</pre>
3563 <p>Add an Object Identifier to an Object Identifier set. This routine
3564 is intended for use in conjunction with gss_create_empty_oid_set
3565 when constructing a set of mechanism OIDs for input to
3566 gss_acquire_cred. The oid_set parameter must refer to an OID-set
3567 that was created by GSS-API (e.g. a set returned by
3568 <a class="link" href="gss-api.html#gss-create-empty-oid-set" title="gss_create_empty_oid_set ()"><code class="function">gss_create_empty_oid_set()</code></a>). GSS-API creates a copy of the
3569 member_oid and inserts this copy into the set, expanding the
3570 storage allocated to the OID-set's elements array if necessary.
3571 The routine may add the new member OID anywhere within the elements
3572 array, and implementations should verify that the new member_oid is
3573 not already contained within the elements array; if the member_oid
3574 is already present, the oid_set should remain unchanged.</p>
3575 <div class="refsect3">
3576 <a name="gss-add-oid-set-member.parameters"></a><h4>Parameters</h4>
3577 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3578 <colgroup>
3579 <col width="150px" class="parameters_name">
3580 <col class="parameters_description">
3581 <col width="200px" class="parameters_annotations">
3582 </colgroup>
3583 <tbody>
3584 <tr>
3585 <td class="parameter_name"><p>minor_status</p></td>
3586 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
3587 <td class="parameter_annotations"> </td>
3588 </tr>
3589 <tr>
3590 <td class="parameter_name"><p>member_oid</p></td>
3591 <td class="parameter_description"><p>(Object ID, read) The object identifier to copied into
3592 the set.</p></td>
3593 <td class="parameter_annotations"> </td>
3594 </tr>
3595 <tr>
3596 <td class="parameter_name"><p>oid_set</p></td>
3597 <td class="parameter_description"><p>(Set of Object ID, modify) The set in which the object
3598 identifier should be inserted.</p></td>
3599 <td class="parameter_annotations"> </td>
3600 </tr>
3601 </tbody>
3602 </table></div>
3603 </div>
3604 <div class="refsect3">
3605 <a name="gss-add-oid-set-member.returns"></a><h4>Returns</h4>
3606 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3607 </div>
3608 </div>
3609 <hr>
3610 <div class="refsect2">
3611 <a name="gss-test-oid-set-member"></a><h3>gss_test_oid_set_member ()</h3>
3612 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3613 gss_test_oid_set_member (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3614 <em class="parameter"><code>const <span class="type">gss_OID</span> member</code></em>,
3615 <em class="parameter"><code>const <span class="type">gss_OID_set</span> set</code></em>,
3616 <em class="parameter"><code><span class="type">int</span> *present</code></em>);</pre>
3617 <p>Interrogate an Object Identifier set to determine whether a
3618 specified Object Identifier is a member. This routine is intended
3619 to be used with OID sets returned by <a class="link" href="gss-api.html#gss-indicate-mechs" title="gss_indicate_mechs ()"><code class="function">gss_indicate_mechs()</code></a>,
3620 <a class="link" href="gss-api.html#gss-acquire-cred" title="gss_acquire_cred ()"><code class="function">gss_acquire_cred()</code></a>, and <a class="link" href="gss-api.html#gss-inquire-cred" title="gss_inquire_cred ()"><code class="function">gss_inquire_cred()</code></a>, but will also work with
3621 user-generated sets.</p>
3622 <div class="refsect3">
3623 <a name="gss-test-oid-set-member.parameters"></a><h4>Parameters</h4>
3624 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3625 <colgroup>
3626 <col width="150px" class="parameters_name">
3627 <col class="parameters_description">
3628 <col width="200px" class="parameters_annotations">
3629 </colgroup>
3630 <tbody>
3631 <tr>
3632 <td class="parameter_name"><p>minor_status</p></td>
3633 <td class="parameter_description"><p>(integer, modify) Mechanism specific status code.</p></td>
3634 <td class="parameter_annotations"> </td>
3635 </tr>
3636 <tr>
3637 <td class="parameter_name"><p>member</p></td>
3638 <td class="parameter_description"><p>(Object ID, read) The object identifier whose presence is
3639 to be tested.</p></td>
3640 <td class="parameter_annotations"> </td>
3641 </tr>
3642 <tr>
3643 <td class="parameter_name"><p>set</p></td>
3644 <td class="parameter_description"><p>(Set of Object ID, read) The Object Identifier set.</p></td>
3645 <td class="parameter_annotations"> </td>
3646 </tr>
3647 <tr>
3648 <td class="parameter_name"><p>present</p></td>
3649 <td class="parameter_description"><p>(Boolean, modify) Non-zero if the specified OID is a
3650 member of the set, zero if not.</p></td>
3651 <td class="parameter_annotations"> </td>
3652 </tr>
3653 </tbody>
3654 </table></div>
3655 </div>
3656 <div class="refsect3">
3657 <a name="gss-test-oid-set-member.returns"></a><h4>Returns</h4>
3658 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3659 </div>
3660 </div>
3661 <hr>
3662 <div class="refsect2">
3663 <a name="gss-inquire-names-for-mech"></a><h3>gss_inquire_names_for_mech ()</h3>
3664 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3665 gss_inquire_names_for_mech (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3666 <em class="parameter"><code>const <span class="type">gss_OID</span> mechanism</code></em>,
3667 <em class="parameter"><code><span class="type">gss_OID_set</span> *name_types</code></em>);</pre>
3668 <p>Returns the set of nametypes supported by the specified mechanism.</p>
3669 <div class="refsect3">
3670 <a name="gss-inquire-names-for-mech.parameters"></a><h4>Parameters</h4>
3671 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3672 <colgroup>
3673 <col width="150px" class="parameters_name">
3674 <col class="parameters_description">
3675 <col width="200px" class="parameters_annotations">
3676 </colgroup>
3677 <tbody>
3678 <tr>
3679 <td class="parameter_name"><p>minor_status</p></td>
3680 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3681 <td class="parameter_annotations"> </td>
3682 </tr>
3683 <tr>
3684 <td class="parameter_name"><p>mechanism</p></td>
3685 <td class="parameter_description"><p>(gss_OID, read) The mechanism to be interrogated.</p></td>
3686 <td class="parameter_annotations"> </td>
3687 </tr>
3688 <tr>
3689 <td class="parameter_name"><p>name_types</p></td>
3690 <td class="parameter_description"><p>(gss_OID_set, modify) Set of name-types supported by
3691 the specified mechanism. The returned OID set must be freed by
3692 the application after use with a call to <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>.</p></td>
3693 <td class="parameter_annotations"> </td>
3694 </tr>
3695 </tbody>
3696 </table></div>
3697 </div>
3698 <div class="refsect3">
3699 <a name="gss-inquire-names-for-mech.returns"></a><h4>Returns</h4>
3700 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3701 </div>
3702 </div>
3703 <hr>
3704 <div class="refsect2">
3705 <a name="gss-inquire-mechs-for-name"></a><h3>gss_inquire_mechs_for_name ()</h3>
3706 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3707 gss_inquire_mechs_for_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3708 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> input_name</code></em>,
3709 <em class="parameter"><code><span class="type">gss_OID_set</span> *mech_types</code></em>);</pre>
3710 <p>Returns the set of mechanisms supported by the GSS-API
3711 implementation that may be able to process the specified name.</p>
3712 <p>Each mechanism returned will recognize at least one element within
3713 the name. It is permissible for this routine to be implemented
3714 within a mechanism-independent GSS-API layer, using the type
3715 information contained within the presented name, and based on
3716 registration information provided by individual mechanism
3717 implementations. This means that the returned mech_types set may
3718 indicate that a particular mechanism will understand the name when
3719 in fact it would refuse to accept the name as input to
3720 gss_canonicalize_name, gss_init_sec_context, gss_acquire_cred or
3721 gss_add_cred (due to some property of the specific name, as opposed
3722 to the name type). Thus this routine should be used only as a
3723 prefilter for a call to a subsequent mechanism-specific routine.</p>
3724 <div class="refsect3">
3725 <a name="gss-inquire-mechs-for-name.parameters"></a><h4>Parameters</h4>
3726 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3727 <colgroup>
3728 <col width="150px" class="parameters_name">
3729 <col class="parameters_description">
3730 <col width="200px" class="parameters_annotations">
3731 </colgroup>
3732 <tbody>
3733 <tr>
3734 <td class="parameter_name"><p>minor_status</p></td>
3735 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3736 <td class="parameter_annotations"> </td>
3737 </tr>
3738 <tr>
3739 <td class="parameter_name"><p>input_name</p></td>
3740 <td class="parameter_description"><p>(gss_name_t, read) The name to which the inquiry
3741 relates.</p></td>
3742 <td class="parameter_annotations"> </td>
3743 </tr>
3744 <tr>
3745 <td class="parameter_name"><p>mech_types</p></td>
3746 <td class="parameter_description"><p>(gss_OID_set, modify) Set of mechanisms that may
3747 support the specified name. The returned OID set must be freed
3748 by the caller after use with a call to <a class="link" href="gss-api.html#gss-release-oid-set" title="gss_release_oid_set ()"><code class="function">gss_release_oid_set()</code></a>.</p></td>
3749 <td class="parameter_annotations"> </td>
3750 </tr>
3751 </tbody>
3752 </table></div>
3753 </div>
3754 <div class="refsect3">
3755 <a name="gss-inquire-mechs-for-name.returns"></a><h4>Returns</h4>
3756 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3757 <p><code class="literal">GSS_S_BAD_NAME</code>: The input_name parameter was ill-formed.</p>
3758 <p><code class="literal">GSS_S_BAD_NAMETYPE</code>: The input_name parameter contained an invalid
3759 or unsupported type of name.</p>
3760 </div>
3761 </div>
3762 <hr>
3763 <div class="refsect2">
3764 <a name="gss-canonicalize-name"></a><h3>gss_canonicalize_name ()</h3>
3765 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3766 gss_canonicalize_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3767 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> input_name</code></em>,
3768 <em class="parameter"><code>const <span class="type">gss_OID</span> mech_type</code></em>,
3769 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *output_name</code></em>);</pre>
3770 <p>Generate a canonical mechanism name (MN) from an arbitrary internal
3771 name. The mechanism name is the name that would be returned to a
3772 context acceptor on successful authentication of a context where
3773 the initiator used the input_name in a successful call to
3774 gss_acquire_cred, specifying an OID set containing <em class="parameter"><code>mech_type</code></em>
3775 as
3776 its only member, followed by a call to <a class="link" href="gss-api.html#gss-init-sec-context" title="gss_init_sec_context ()"><code class="function">gss_init_sec_context()</code></a>,
3777 specifying <em class="parameter"><code>mech_type</code></em>
3778 as the authentication mechanism.</p>
3779 <div class="refsect3">
3780 <a name="gss-canonicalize-name.parameters"></a><h4>Parameters</h4>
3781 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3782 <colgroup>
3783 <col width="150px" class="parameters_name">
3784 <col class="parameters_description">
3785 <col width="200px" class="parameters_annotations">
3786 </colgroup>
3787 <tbody>
3788 <tr>
3789 <td class="parameter_name"><p>minor_status</p></td>
3790 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3791 <td class="parameter_annotations"> </td>
3792 </tr>
3793 <tr>
3794 <td class="parameter_name"><p>input_name</p></td>
3795 <td class="parameter_description"><p>(gss_name_t, read) The name for which a canonical form
3796 is desired.</p></td>
3797 <td class="parameter_annotations"> </td>
3798 </tr>
3799 <tr>
3800 <td class="parameter_name"><p>mech_type</p></td>
3801 <td class="parameter_description"><p>(Object ID, read) The authentication mechanism for
3802 which the canonical form of the name is desired. The desired
3803 mechanism must be specified explicitly; no default is provided.</p></td>
3804 <td class="parameter_annotations"> </td>
3805 </tr>
3806 <tr>
3807 <td class="parameter_name"><p>output_name</p></td>
3808 <td class="parameter_description"><p>(gss_name_t, modify) The resultant canonical name.
3809 Storage associated with this name must be freed by the
3810 application after use with a call to <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>.</p></td>
3811 <td class="parameter_annotations"> </td>
3812 </tr>
3813 </tbody>
3814 </table></div>
3815 </div>
3816 <div class="refsect3">
3817 <a name="gss-canonicalize-name.returns"></a><h4>Returns</h4>
3818 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3819 </div>
3820 </div>
3821 <hr>
3822 <div class="refsect2">
3823 <a name="gss-duplicate-name"></a><h3>gss_duplicate_name ()</h3>
3824 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3825 gss_duplicate_name (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3826 <em class="parameter"><code>const <a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> src_name</code></em>,
3827 <em class="parameter"><code><a class="link" href="gss-api.html#gss-name-t" title="gss_name_t"><span class="type">gss_name_t</span></a> *dest_name</code></em>);</pre>
3828 <p>Create an exact duplicate of the existing internal name <em class="parameter"><code>src_name</code></em>
3829 .
3830 The new <em class="parameter"><code>dest_name</code></em>
3831 will be independent of src_name (i.e. <em class="parameter"><code>src_name</code></em>
3832
3833 and <em class="parameter"><code>dest_name</code></em>
3834 must both be released, and the release of one shall
3835 not affect the validity of the other).</p>
3836 <div class="refsect3">
3837 <a name="gss-duplicate-name.parameters"></a><h4>Parameters</h4>
3838 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3839 <colgroup>
3840 <col width="150px" class="parameters_name">
3841 <col class="parameters_description">
3842 <col width="200px" class="parameters_annotations">
3843 </colgroup>
3844 <tbody>
3845 <tr>
3846 <td class="parameter_name"><p>minor_status</p></td>
3847 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3848 <td class="parameter_annotations"> </td>
3849 </tr>
3850 <tr>
3851 <td class="parameter_name"><p>src_name</p></td>
3852 <td class="parameter_description"><p>(gss_name_t, read) Internal name to be duplicated.</p></td>
3853 <td class="parameter_annotations"> </td>
3854 </tr>
3855 <tr>
3856 <td class="parameter_name"><p>dest_name</p></td>
3857 <td class="parameter_description"><p>(gss_name_t, modify) The resultant copy of <em class="parameter"><code>src_name</code></em>
3858 .
3859 Storage associated with this name must be freed by the application
3860 after use with a call to <a class="link" href="gss-api.html#gss-release-name" title="gss_release_name ()"><code class="function">gss_release_name()</code></a>.</p></td>
3861 <td class="parameter_annotations"> </td>
3862 </tr>
3863 </tbody>
3864 </table></div>
3865 </div>
3866 <div class="refsect3">
3867 <a name="gss-duplicate-name.returns"></a><h4>Returns</h4>
3868 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3869 <p><code class="literal">GSS_S_BAD_NAME</code>: The src_name parameter was ill-formed.</p>
3870 </div>
3871 </div>
3872 <hr>
3873 <div class="refsect2">
3874 <a name="gss-sign"></a><h3>gss_sign ()</h3>
3875 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3876 gss_sign (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3877 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
3878 <em class="parameter"><code><span class="type">int</span> qop_req</code></em>,
3879 <em class="parameter"><code><span class="type">gss_buffer_t</span> message_buffer</code></em>,
3880 <em class="parameter"><code><span class="type">gss_buffer_t</span> message_token</code></em>);</pre>
3881 </div>
3882 <hr>
3883 <div class="refsect2">
3884 <a name="gss-verify"></a><h3>gss_verify ()</h3>
3885 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3886 gss_verify (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3887 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
3888 <em class="parameter"><code><span class="type">gss_buffer_t</span> message_buffer</code></em>,
3889 <em class="parameter"><code><span class="type">gss_buffer_t</span> token_buffer</code></em>,
3890 <em class="parameter"><code><span class="type">int</span> *qop_state</code></em>);</pre>
3891 </div>
3892 <hr>
3893 <div class="refsect2">
3894 <a name="gss-seal"></a><h3>gss_seal ()</h3>
3895 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3896 gss_seal (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3897 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
3898 <em class="parameter"><code><span class="type">int</span> conf_req_flag</code></em>,
3899 <em class="parameter"><code><span class="type">int</span> qop_req</code></em>,
3900 <em class="parameter"><code><span class="type">gss_buffer_t</span> input_message_buffer</code></em>,
3901 <em class="parameter"><code><span class="type">int</span> *conf_state</code></em>,
3902 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_message_buffer</code></em>);</pre>
3903 </div>
3904 <hr>
3905 <div class="refsect2">
3906 <a name="gss-unseal"></a><h3>gss_unseal ()</h3>
3907 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3908 gss_unseal (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3909 <em class="parameter"><code><a class="link" href="gss-api.html#gss-ctx-id-t" title="gss_ctx_id_t"><span class="type">gss_ctx_id_t</span></a> context_handle</code></em>,
3910 <em class="parameter"><code><span class="type">gss_buffer_t</span> input_message_buffer</code></em>,
3911 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_message_buffer</code></em>,
3912 <em class="parameter"><code><span class="type">int</span> *conf_state</code></em>,
3913 <em class="parameter"><code><span class="type">int</span> *qop_state</code></em>);</pre>
3914 </div>
3915 <hr>
3916 <div class="refsect2">
3917 <a name="gss-inquire-saslname-for-mech"></a><h3>gss_inquire_saslname_for_mech ()</h3>
3918 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3919 gss_inquire_saslname_for_mech (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3920 <em class="parameter"><code>const <span class="type">gss_OID</span> desired_mech</code></em>,
3921 <em class="parameter"><code><span class="type">gss_buffer_t</span> sasl_mech_name</code></em>,
3922 <em class="parameter"><code><span class="type">gss_buffer_t</span> mech_name</code></em>,
3923 <em class="parameter"><code><span class="type">gss_buffer_t</span> mech_description</code></em>);</pre>
3924 <p>Output the SASL mechanism name of a GSS-API mechanism. It also
3925 returns a name and description of the mechanism in a user friendly
3926 form.</p>
3927 <div class="refsect3">
3928 <a name="gss-inquire-saslname-for-mech.parameters"></a><h4>Parameters</h4>
3929 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3930 <colgroup>
3931 <col width="150px" class="parameters_name">
3932 <col class="parameters_description">
3933 <col width="200px" class="parameters_annotations">
3934 </colgroup>
3935 <tbody>
3936 <tr>
3937 <td class="parameter_name"><p>minor_status</p></td>
3938 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
3939 <td class="parameter_annotations"> </td>
3940 </tr>
3941 <tr>
3942 <td class="parameter_name"><p>desired_mech</p></td>
3943 <td class="parameter_description"><p>(OID, read) Identifies the GSS-API mechanism to query.</p></td>
3944 <td class="parameter_annotations"> </td>
3945 </tr>
3946 <tr>
3947 <td class="parameter_name"><p>sasl_mech_name</p></td>
3948 <td class="parameter_description"><p>(buffer, character-string, modify, optional)
3949 Buffer to receive SASL mechanism name. The application must free
3950 storage associated with this name after use with a call to
3951 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
3952 <td class="parameter_annotations"> </td>
3953 </tr>
3954 <tr>
3955 <td class="parameter_name"><p>mech_name</p></td>
3956 <td class="parameter_description"><p>(buffer, character-string, modify, optional) Buffer to
3957 receive human readable mechanism name. The application must free
3958 storage associated with this name after use with a call to
3959 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
3960 <td class="parameter_annotations"> </td>
3961 </tr>
3962 <tr>
3963 <td class="parameter_name"><p>mech_description</p></td>
3964 <td class="parameter_description"><p>(buffer, character-string, modify, optional)
3965 Buffer to receive description of mechanism. The application must
3966 free storage associated with this name after use with a call to
3967 <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
3968 <td class="parameter_annotations"> </td>
3969 </tr>
3970 </tbody>
3971 </table></div>
3972 </div>
3973 <div class="refsect3">
3974 <a name="gss-inquire-saslname-for-mech.returns"></a><h4>Returns</h4>
3975 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
3976 <p><code class="literal">GSS_S_BAD_MECH</code>: The <em class="parameter"><code>desired_mech</code></em>
3977 OID is unsupported.</p>
3978 </div>
3979 </div>
3980 <hr>
3981 <div class="refsect2">
3982 <a name="gss-inquire-mech-for-saslname"></a><h3>gss_inquire_mech_for_saslname ()</h3>
3983 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
3984 gss_inquire_mech_for_saslname (<em class="parameter"><code><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="type">OM_uint32</span></a> *minor_status</code></em>,
3985 <em class="parameter"><code>const <span class="type">gss_buffer_t</span> sasl_mech_name</code></em>,
3986 <em class="parameter"><code><span class="type">gss_OID</span> *mech_type</code></em>);</pre>
3987 <p>Output GSS-API mechanism OID of mechanism associated with given
3988 <em class="parameter"><code>sasl_mech_name</code></em>
3989 .</p>
3990 <div class="refsect3">
3991 <a name="gss-inquire-mech-for-saslname.parameters"></a><h4>Parameters</h4>
3992 <div class="informaltable"><table class="informaltable" width="100%" border="0">
3993 <colgroup>
3994 <col width="150px" class="parameters_name">
3995 <col class="parameters_description">
3996 <col width="200px" class="parameters_annotations">
3997 </colgroup>
3998 <tbody>
3999 <tr>
4000 <td class="parameter_name"><p>minor_status</p></td>
4001 <td class="parameter_description"><p>(Integer, modify) Mechanism specific status code.</p></td>
4002 <td class="parameter_annotations"> </td>
4003 </tr>
4004 <tr>
4005 <td class="parameter_name"><p>sasl_mech_name</p></td>
4006 <td class="parameter_description"><p>(buffer, character-string, read) Buffer with SASL
4007 mechanism name.</p></td>
4008 <td class="parameter_annotations"> </td>
4009 </tr>
4010 <tr>
4011 <td class="parameter_name"><p>mech_type</p></td>
4012 <td class="parameter_description"><p>(OID, modify, optional) Actual mechanism used. The OID
4013 returned via this parameter will be a pointer to static storage
4014 that should be treated as read-only; In particular the
4015 application should not attempt to free it. Specify NULL if not
4016 required.</p></td>
4017 <td class="parameter_annotations"> </td>
4018 </tr>
4019 </tbody>
4020 </table></div>
4021 </div>
4022 <div class="refsect3">
4023 <a name="gss-inquire-mech-for-saslname.returns"></a><h4>Returns</h4>
4024 <p><code class="literal">GSS_S_COMPLETE</code>: Successful completion.</p>
4025 <p><code class="literal">GSS_S_BAD_MECH</code>: There is no GSS-API mechanism known as <em class="parameter"><code>sasl_mech_name</code></em>
4026 .</p>
4027 </div>
4028 </div>
4029 <hr>
4030 <div class="refsect2">
4031 <a name="gss-oid-equal"></a><h3>gss_oid_equal ()</h3>
4032 <pre class="programlisting"><span class="returnvalue">int</span>
4033 gss_oid_equal (<em class="parameter"><code><a class="link" href="gss-api.html#gss-const-OID" title="gss_const_OID"><span class="type">gss_const_OID</span></a> first_oid</code></em>,
4034 <em class="parameter"><code><a class="link" href="gss-api.html#gss-const-OID" title="gss_const_OID"><span class="type">gss_const_OID</span></a> second_oid</code></em>);</pre>
4035 <p>Compare two OIDs for equality. The comparison is "deep", i.e., the
4036 actual byte sequences of the OIDs are compared instead of just the
4037 pointer equality. This function is standardized in RFC 6339.</p>
4038 <div class="refsect3">
4039 <a name="gss-oid-equal.parameters"></a><h4>Parameters</h4>
4040 <div class="informaltable"><table class="informaltable" width="100%" border="0">
4041 <colgroup>
4042 <col width="150px" class="parameters_name">
4043 <col class="parameters_description">
4044 <col width="200px" class="parameters_annotations">
4045 </colgroup>
4046 <tbody>
4047 <tr>
4048 <td class="parameter_name"><p>first_oid</p></td>
4049 <td class="parameter_description"><p>(Object ID, read) First Object identifier.</p></td>
4050 <td class="parameter_annotations"> </td>
4051 </tr>
4052 <tr>
4053 <td class="parameter_name"><p>second_oid</p></td>
4054 <td class="parameter_description"><p>(Object ID, read) First Object identifier.</p></td>
4055 <td class="parameter_annotations"> </td>
4056 </tr>
4057 </tbody>
4058 </table></div>
4059 </div>
4060 <div class="refsect3">
4061 <a name="gss-oid-equal.returns"></a><h4>Returns</h4>
4062 <p> Returns boolean value true when the two OIDs are
4063 equal, otherwise false.</p>
4064 </div>
4065 </div>
4066 <hr>
4067 <div class="refsect2">
4068 <a name="gss-encapsulate-token"></a><h3>gss_encapsulate_token ()</h3>
4069 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
4070 gss_encapsulate_token (<em class="parameter"><code><a class="link" href="gss-api.html#gss-const-buffer-t" title="gss_const_buffer_t"><span class="type">gss_const_buffer_t</span></a> input_token</code></em>,
4071 <em class="parameter"><code><a class="link" href="gss-api.html#gss-const-OID" title="gss_const_OID"><span class="type">gss_const_OID</span></a> token_oid</code></em>,
4072 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_token</code></em>);</pre>
4073 <p>Add the mechanism-independent token header to GSS-API context token
4074 data. This is used for the initial token of a GSS-API context
4075 establishment sequence. It incorporates an identifier of the
4076 mechanism type to be used on that context, and enables tokens to be
4077 interpreted unambiguously at GSS-API peers. See further section
4078 3.1 of RFC 2743. This function is standardized in RFC 6339.</p>
4079 <div class="refsect3">
4080 <a name="gss-encapsulate-token.parameters"></a><h4>Parameters</h4>
4081 <div class="informaltable"><table class="informaltable" width="100%" border="0">
4082 <colgroup>
4083 <col width="150px" class="parameters_name">
4084 <col class="parameters_description">
4085 <col width="200px" class="parameters_annotations">
4086 </colgroup>
4087 <tbody>
4088 <tr>
4089 <td class="parameter_name"><p>input_token</p></td>
4090 <td class="parameter_description"><p>(buffer, opaque, read) Buffer with GSS-API context token data.</p></td>
4091 <td class="parameter_annotations"> </td>
4092 </tr>
4093 <tr>
4094 <td class="parameter_name"><p>token_oid</p></td>
4095 <td class="parameter_description"><p>(Object ID, read) Object identifier of token.</p></td>
4096 <td class="parameter_annotations"> </td>
4097 </tr>
4098 <tr>
4099 <td class="parameter_name"><p>output_token</p></td>
4100 <td class="parameter_description"><p>(buffer, opaque, modify) Encapsulated token data;
4101 caller must release with <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
4102 <td class="parameter_annotations"> </td>
4103 </tr>
4104 </tbody>
4105 </table></div>
4106 </div>
4107 <div class="refsect3">
4108 <a name="gss-encapsulate-token.returns"></a><h4>Returns</h4>
4109 <p><code class="literal">GSS_S_COMPLETE</code>: Indicates successful completion, and that output
4110 parameters holds correct information.</p>
4111 <p><code class="literal">GSS_S_FAILURE</code>: Indicates that encapsulation failed for reasons
4112 unspecified at the GSS-API level.</p>
4113 </div>
4114 </div>
4115 <hr>
4116 <div class="refsect2">
4117 <a name="gss-decapsulate-token"></a><h3>gss_decapsulate_token ()</h3>
4118 <pre class="programlisting"><a class="link" href="gss-api.html#OM-uint32" title="OM_uint32"><span class="returnvalue">OM_uint32</span></a>
4119 gss_decapsulate_token (<em class="parameter"><code><a class="link" href="gss-api.html#gss-const-buffer-t" title="gss_const_buffer_t"><span class="type">gss_const_buffer_t</span></a> input_token</code></em>,
4120 <em class="parameter"><code><a class="link" href="gss-api.html#gss-const-OID" title="gss_const_OID"><span class="type">gss_const_OID</span></a> token_oid</code></em>,
4121 <em class="parameter"><code><span class="type">gss_buffer_t</span> output_token</code></em>);</pre>
4122 <p>Remove the mechanism-independent token header from an initial
4123 GSS-API context token. Unwrap a buffer in the
4124 mechanism-independent token format. This is the reverse of
4125 <a class="link" href="gss-api.html#gss-encapsulate-token" title="gss_encapsulate_token ()"><code class="function">gss_encapsulate_token()</code></a>. The translation is loss-less, all data is
4126 preserved as is. This function is standardized in RFC 6339.</p>
4127 <div class="refsect3">
4128 <a name="gss-decapsulate-token.parameters"></a><h4>Parameters</h4>
4129 <div class="informaltable"><table class="informaltable" width="100%" border="0">
4130 <colgroup>
4131 <col width="150px" class="parameters_name">
4132 <col class="parameters_description">
4133 <col width="200px" class="parameters_annotations">
4134 </colgroup>
4135 <tbody>
4136 <tr>
4137 <td class="parameter_name"><p>input_token</p></td>
4138 <td class="parameter_description"><p>(buffer, opaque, read) Buffer with GSS-API context token.</p></td>
4139 <td class="parameter_annotations"> </td>
4140 </tr>
4141 <tr>
4142 <td class="parameter_name"><p>token_oid</p></td>
4143 <td class="parameter_description"><p>(Object ID, read) Expected object identifier of token.</p></td>
4144 <td class="parameter_annotations"> </td>
4145 </tr>
4146 <tr>
4147 <td class="parameter_name"><p>output_token</p></td>
4148 <td class="parameter_description"><p>(buffer, opaque, modify) Decapsulated token data;
4149 caller must release with <a class="link" href="gss-api.html#gss-release-buffer" title="gss_release_buffer ()"><code class="function">gss_release_buffer()</code></a>.</p></td>
4150 <td class="parameter_annotations"> </td>
4151 </tr>
4152 </tbody>
4153 </table></div>
4154 </div>
4155 <div class="refsect3">
4156 <a name="gss-decapsulate-token.returns"></a><h4>Returns</h4>
4157 <p><code class="literal">GSS_S_COMPLETE</code>: Indicates successful completion, and that output
4158 parameters holds correct information.</p>
4159 <p><code class="literal">GSS_S_DEFECTIVE_TOKEN</code>: Means that the token failed consistency
4160 checks (e.g., OID mismatch or ASN.1 DER length errors).</p>
4161 <p><code class="literal">GSS_S_FAILURE</code>: Indicates that decapsulation failed for reasons
4162 unspecified at the GSS-API level.</p>
4163 </div>
4164 </div>
4165 </div>
4166 <div class="refsect1">
4167 <a name="gss-api.other_details"></a><h2>Types and Values</h2>
4168 <div class="refsect2">
4169 <a name="gss-ctx-id-t"></a><h3>gss_ctx_id_t</h3>
4170 <pre class="programlisting">typedef struct gss_ctx_id_struct *gss_ctx_id_t;
4171 </pre>
4172 </div>
4173 <hr>
4174 <div class="refsect2">
4175 <a name="gss-cred-id-t"></a><h3>gss_cred_id_t</h3>
4176 <pre class="programlisting">typedef struct gss_cred_id_struct *gss_cred_id_t;
4177 </pre>
4178 </div>
4179 <hr>
4180 <div class="refsect2">
4181 <a name="gss-name-t"></a><h3>gss_name_t</h3>
4182 <pre class="programlisting">typedef struct gss_name_struct *gss_name_t;
4183 </pre>
4184 </div>
4185 <hr>
4186 <div class="refsect2">
4187 <a name="gss-uint32"></a><h3>gss_uint32</h3>
4188 <pre class="programlisting">typedef unsigned short gss_uint32;
4189 </pre>
4190 </div>
4191 <hr>
4192 <div class="refsect2">
4193 <a name="OM-uint32"></a><h3>OM_uint32</h3>
4194 <pre class="programlisting">typedef gss_uint32 OM_uint32;
4195 </pre>
4196 </div>
4197 <hr>
4198 <div class="refsect2">
4199 <a name="gss-qop-t"></a><h3>gss_qop_t</h3>
4200 <pre class="programlisting">typedef OM_uint32 gss_qop_t;
4201 </pre>
4202 </div>
4203 <hr>
4204 <div class="refsect2">
4205 <a name="gss-cred-usage-t"></a><h3>gss_cred_usage_t</h3>
4206 <pre class="programlisting">typedef int gss_cred_usage_t;
4207 </pre>
4208 </div>
4209 <hr>
4210 <div class="refsect2">
4211 <a name="GSS-C-DELEG-FLAG:CAPS"></a><h3>GSS_C_DELEG_FLAG</h3>
4212 <pre class="programlisting"># define GSS_C_DELEG_FLAG 1
4213 </pre>
4214 </div>
4215 <hr>
4216 <div class="refsect2">
4217 <a name="GSS-C-MUTUAL-FLAG:CAPS"></a><h3>GSS_C_MUTUAL_FLAG</h3>
4218 <pre class="programlisting"># define GSS_C_MUTUAL_FLAG 2
4219 </pre>
4220 </div>
4221 <hr>
4222 <div class="refsect2">
4223 <a name="GSS-C-REPLAY-FLAG:CAPS"></a><h3>GSS_C_REPLAY_FLAG</h3>
4224 <pre class="programlisting"># define GSS_C_REPLAY_FLAG 4
4225 </pre>
4226 </div>
4227 <hr>
4228 <div class="refsect2">
4229 <a name="GSS-C-SEQUENCE-FLAG:CAPS"></a><h3>GSS_C_SEQUENCE_FLAG</h3>
4230 <pre class="programlisting"># define GSS_C_SEQUENCE_FLAG 8
4231 </pre>
4232 </div>
4233 <hr>
4234 <div class="refsect2">
4235 <a name="GSS-C-CONF-FLAG:CAPS"></a><h3>GSS_C_CONF_FLAG</h3>
4236 <pre class="programlisting"># define GSS_C_CONF_FLAG 16
4237 </pre>
4238 </div>
4239 <hr>
4240 <div class="refsect2">
4241 <a name="GSS-C-INTEG-FLAG:CAPS"></a><h3>GSS_C_INTEG_FLAG</h3>
4242 <pre class="programlisting"># define GSS_C_INTEG_FLAG 32
4243 </pre>
4244 </div>
4245 <hr>
4246 <div class="refsect2">
4247 <a name="GSS-C-ANON-FLAG:CAPS"></a><h3>GSS_C_ANON_FLAG</h3>
4248 <pre class="programlisting"># define GSS_C_ANON_FLAG 64
4249 </pre>
4250 </div>
4251 <hr>
4252 <div class="refsect2">
4253 <a name="GSS-C-PROT-READY-FLAG:CAPS"></a><h3>GSS_C_PROT_READY_FLAG</h3>
4254 <pre class="programlisting"># define GSS_C_PROT_READY_FLAG 128
4255 </pre>
4256 </div>
4257 <hr>
4258 <div class="refsect2">
4259 <a name="GSS-C-TRANS-FLAG:CAPS"></a><h3>GSS_C_TRANS_FLAG</h3>
4260 <pre class="programlisting"># define GSS_C_TRANS_FLAG 256
4261 </pre>
4262 </div>
4263 <hr>
4264 <div class="refsect2">
4265 <a name="GSS-C-BOTH:CAPS"></a><h3>GSS_C_BOTH</h3>
4266 <pre class="programlisting"># define GSS_C_BOTH 0
4267 </pre>
4268 </div>
4269 <hr>
4270 <div class="refsect2">
4271 <a name="GSS-C-INITIATE:CAPS"></a><h3>GSS_C_INITIATE</h3>
4272 <pre class="programlisting"># define GSS_C_INITIATE 1
4273 </pre>
4274 </div>
4275 <hr>
4276 <div class="refsect2">
4277 <a name="GSS-C-ACCEPT:CAPS"></a><h3>GSS_C_ACCEPT</h3>
4278 <pre class="programlisting"># define GSS_C_ACCEPT 2
4279 </pre>
4280 </div>
4281 <hr>
4282 <div class="refsect2">
4283 <a name="GSS-C-GSS-CODE:CAPS"></a><h3>GSS_C_GSS_CODE</h3>
4284 <pre class="programlisting"># define GSS_C_GSS_CODE 1
4285 </pre>
4286 </div>
4287 <hr>
4288 <div class="refsect2">
4289 <a name="GSS-C-MECH-CODE:CAPS"></a><h3>GSS_C_MECH_CODE</h3>
4290 <pre class="programlisting"># define GSS_C_MECH_CODE 2
4291 </pre>
4292 </div>
4293 <hr>
4294 <div class="refsect2">
4295 <a name="GSS-C-AF-UNSPEC:CAPS"></a><h3>GSS_C_AF_UNSPEC</h3>
4296 <pre class="programlisting"># define GSS_C_AF_UNSPEC 0
4297 </pre>
4298 </div>
4299 <hr>
4300 <div class="refsect2">
4301 <a name="GSS-C-AF-LOCAL:CAPS"></a><h3>GSS_C_AF_LOCAL</h3>
4302 <pre class="programlisting"># define GSS_C_AF_LOCAL 1
4303 </pre>
4304 </div>
4305 <hr>
4306 <div class="refsect2">
4307 <a name="GSS-C-AF-INET:CAPS"></a><h3>GSS_C_AF_INET</h3>
4308 <pre class="programlisting"># define GSS_C_AF_INET 2
4309 </pre>
4310 </div>
4311 <hr>
4312 <div class="refsect2">
4313 <a name="GSS-C-AF-IMPLINK:CAPS"></a><h3>GSS_C_AF_IMPLINK</h3>
4314 <pre class="programlisting"># define GSS_C_AF_IMPLINK 3
4315 </pre>
4316 </div>
4317 <hr>
4318 <div class="refsect2">
4319 <a name="GSS-C-AF-PUP:CAPS"></a><h3>GSS_C_AF_PUP</h3>
4320 <pre class="programlisting"># define GSS_C_AF_PUP 4
4321 </pre>
4322 </div>
4323 <hr>
4324 <div class="refsect2">
4325 <a name="GSS-C-AF-CHAOS:CAPS"></a><h3>GSS_C_AF_CHAOS</h3>
4326 <pre class="programlisting"># define GSS_C_AF_CHAOS 5
4327 </pre>
4328 </div>
4329 <hr>
4330 <div class="refsect2">
4331 <a name="GSS-C-AF-NS:CAPS"></a><h3>GSS_C_AF_NS</h3>
4332 <pre class="programlisting"># define GSS_C_AF_NS 6
4333 </pre>
4334 </div>
4335 <hr>
4336 <div class="refsect2">
4337 <a name="GSS-C-AF-NBS:CAPS"></a><h3>GSS_C_AF_NBS</h3>
4338 <pre class="programlisting"># define GSS_C_AF_NBS 7
4339 </pre>
4340 </div>
4341 <hr>
4342 <div class="refsect2">
4343 <a name="GSS-C-AF-ECMA:CAPS"></a><h3>GSS_C_AF_ECMA</h3>
4344 <pre class="programlisting"># define GSS_C_AF_ECMA 8
4345 </pre>
4346 </div>
4347 <hr>
4348 <div class="refsect2">
4349 <a name="GSS-C-AF-DATAKIT:CAPS"></a><h3>GSS_C_AF_DATAKIT</h3>
4350 <pre class="programlisting"># define GSS_C_AF_DATAKIT 9
4351 </pre>
4352 </div>
4353 <hr>
4354 <div class="refsect2">
4355 <a name="GSS-C-AF-CCITT:CAPS"></a><h3>GSS_C_AF_CCITT</h3>
4356 <pre class="programlisting"># define GSS_C_AF_CCITT 10
4357 </pre>
4358 </div>
4359 <hr>
4360 <div class="refsect2">
4361 <a name="GSS-C-AF-SNA:CAPS"></a><h3>GSS_C_AF_SNA</h3>
4362 <pre class="programlisting"># define GSS_C_AF_SNA 11
4363 </pre>
4364 </div>
4365 <hr>
4366 <div class="refsect2">
4367 <a name="GSS-C-AF-DECnet"></a><h3>GSS_C_AF_DECnet</h3>
4368 <pre class="programlisting"># define GSS_C_AF_DECnet 12
4369 </pre>
4370 </div>
4371 <hr>
4372 <div class="refsect2">
4373 <a name="GSS-C-AF-DLI:CAPS"></a><h3>GSS_C_AF_DLI</h3>
4374 <pre class="programlisting"># define GSS_C_AF_DLI 13
4375 </pre>
4376 </div>
4377 <hr>
4378 <div class="refsect2">
4379 <a name="GSS-C-AF-LAT:CAPS"></a><h3>GSS_C_AF_LAT</h3>
4380 <pre class="programlisting"># define GSS_C_AF_LAT 14
4381 </pre>
4382 </div>
4383 <hr>
4384 <div class="refsect2">
4385 <a name="GSS-C-AF-HYLINK:CAPS"></a><h3>GSS_C_AF_HYLINK</h3>
4386 <pre class="programlisting"># define GSS_C_AF_HYLINK 15
4387 </pre>
4388 </div>
4389 <hr>
4390 <div class="refsect2">
4391 <a name="GSS-C-AF-APPLETALK:CAPS"></a><h3>GSS_C_AF_APPLETALK</h3>
4392 <pre class="programlisting"># define GSS_C_AF_APPLETALK 16
4393 </pre>
4394 </div>
4395 <hr>
4396 <div class="refsect2">
4397 <a name="GSS-C-AF-BSC:CAPS"></a><h3>GSS_C_AF_BSC</h3>
4398 <pre class="programlisting"># define GSS_C_AF_BSC 17
4399 </pre>
4400 </div>
4401 <hr>
4402 <div class="refsect2">
4403 <a name="GSS-C-AF-DSS:CAPS"></a><h3>GSS_C_AF_DSS</h3>
4404 <pre class="programlisting"># define GSS_C_AF_DSS 18
4405 </pre>
4406 </div>
4407 <hr>
4408 <div class="refsect2">
4409 <a name="GSS-C-AF-OSI:CAPS"></a><h3>GSS_C_AF_OSI</h3>
4410 <pre class="programlisting"># define GSS_C_AF_OSI 19
4411 </pre>
4412 </div>
4413 <hr>
4414 <div class="refsect2">
4415 <a name="GSS-C-AF-X25:CAPS"></a><h3>GSS_C_AF_X25</h3>
4416 <pre class="programlisting"># define GSS_C_AF_X25 21
4417 </pre>
4418 </div>
4419 <hr>
4420 <div class="refsect2">
4421 <a name="GSS-C-AF-NULLADDR:CAPS"></a><h3>GSS_C_AF_NULLADDR</h3>
4422 <pre class="programlisting"># define GSS_C_AF_NULLADDR 255
4423 </pre>
4424 </div>
4425 <hr>
4426 <div class="refsect2">
4427 <a name="GSS-C-NO-NAME:CAPS"></a><h3>GSS_C_NO_NAME</h3>
4428 <pre class="programlisting"># define GSS_C_NO_NAME ((gss_name_t) 0)
4429 </pre>
4430 </div>
4431 <hr>
4432 <div class="refsect2">
4433 <a name="GSS-C-NO-BUFFER:CAPS"></a><h3>GSS_C_NO_BUFFER</h3>
4434 <pre class="programlisting"># define GSS_C_NO_BUFFER ((gss_buffer_t) 0)
4435 </pre>
4436 </div>
4437 <hr>
4438 <div class="refsect2">
4439 <a name="GSS-C-NO-OID:CAPS"></a><h3>GSS_C_NO_OID</h3>
4440 <pre class="programlisting"># define GSS_C_NO_OID ((gss_OID) 0)
4441 </pre>
4442 </div>
4443 <hr>
4444 <div class="refsect2">
4445 <a name="GSS-C-NO-OID-SET:CAPS"></a><h3>GSS_C_NO_OID_SET</h3>
4446 <pre class="programlisting"># define GSS_C_NO_OID_SET ((gss_OID_set) 0)
4447 </pre>
4448 </div>
4449 <hr>
4450 <div class="refsect2">
4451 <a name="GSS-C-NO-CONTEXT:CAPS"></a><h3>GSS_C_NO_CONTEXT</h3>
4452 <pre class="programlisting"># define GSS_C_NO_CONTEXT ((gss_ctx_id_t) 0)
4453 </pre>
4454 </div>
4455 <hr>
4456 <div class="refsect2">
4457 <a name="GSS-C-NO-CREDENTIAL:CAPS"></a><h3>GSS_C_NO_CREDENTIAL</h3>
4458 <pre class="programlisting"># define GSS_C_NO_CREDENTIAL ((gss_cred_id_t) 0)
4459 </pre>
4460 </div>
4461 <hr>
4462 <div class="refsect2">
4463 <a name="GSS-C-NO-CHANNEL-BINDINGS:CAPS"></a><h3>GSS_C_NO_CHANNEL_BINDINGS</h3>
4464 <pre class="programlisting"># define GSS_C_NO_CHANNEL_BINDINGS ((gss_channel_bindings_t) 0)
4465 </pre>
4466 </div>
4467 <hr>
4468 <div class="refsect2">
4469 <a name="GSS-C-EMPTY-BUFFER:CAPS"></a><h3>GSS_C_EMPTY_BUFFER</h3>
4470 <pre class="programlisting"># define GSS_C_EMPTY_BUFFER {0, NULL}
4471 </pre>
4472 </div>
4473 <hr>
4474 <div class="refsect2">
4475 <a name="GSS-C-NULL-OID:CAPS"></a><h3>GSS_C_NULL_OID</h3>
4476 <pre class="programlisting"># define GSS_C_NULL_OID GSS_C_NO_OID
4477 </pre>
4478 </div>
4479 <hr>
4480 <div class="refsect2">
4481 <a name="GSS-C-NULL-OID-SET:CAPS"></a><h3>GSS_C_NULL_OID_SET</h3>
4482 <pre class="programlisting"># define GSS_C_NULL_OID_SET GSS_C_NO_OID_SET
4483 </pre>
4484 </div>
4485 <hr>
4486 <div class="refsect2">
4487 <a name="GSS-C-QOP-DEFAULT:CAPS"></a><h3>GSS_C_QOP_DEFAULT</h3>
4488 <pre class="programlisting"># define GSS_C_QOP_DEFAULT 0
4489 </pre>
4490 </div>
4491 <hr>
4492 <div class="refsect2">
4493 <a name="GSS-C-INDEFINITE:CAPS"></a><h3>GSS_C_INDEFINITE</h3>
4494 <pre class="programlisting"># define GSS_C_INDEFINITE 0xfffffffful
4495 </pre>
4496 </div>
4497 <hr>
4498 <div class="refsect2">
4499 <a name="GSS-C-NT-USER-NAME:CAPS"></a><h3>GSS_C_NT_USER_NAME</h3>
4500 <pre class="programlisting">extern gss_OID GSS_C_NT_USER_NAME;
4501 </pre>
4502 </div>
4503 <hr>
4504 <div class="refsect2">
4505 <a name="GSS-C-NT-MACHINE-UID-NAME:CAPS"></a><h3>GSS_C_NT_MACHINE_UID_NAME</h3>
4506 <pre class="programlisting">extern gss_OID GSS_C_NT_MACHINE_UID_NAME;
4507 </pre>
4508 </div>
4509 <hr>
4510 <div class="refsect2">
4511 <a name="GSS-C-NT-STRING-UID-NAME:CAPS"></a><h3>GSS_C_NT_STRING_UID_NAME</h3>
4512 <pre class="programlisting">extern gss_OID GSS_C_NT_STRING_UID_NAME;
4513 </pre>
4514 </div>
4515 <hr>
4516 <div class="refsect2">
4517 <a name="GSS-C-NT-HOSTBASED-SERVICE-X:CAPS"></a><h3>GSS_C_NT_HOSTBASED_SERVICE_X</h3>
4518 <pre class="programlisting">extern gss_OID GSS_C_NT_HOSTBASED_SERVICE_X;
4519 </pre>
4520 </div>
4521 <hr>
4522 <div class="refsect2">
4523 <a name="GSS-C-NT-HOSTBASED-SERVICE:CAPS"></a><h3>GSS_C_NT_HOSTBASED_SERVICE</h3>
4524 <pre class="programlisting">extern gss_OID GSS_C_NT_HOSTBASED_SERVICE;
4525 </pre>
4526 </div>
4527 <hr>
4528 <div class="refsect2">
4529 <a name="GSS-C-NT-ANONYMOUS:CAPS"></a><h3>GSS_C_NT_ANONYMOUS</h3>
4530 <pre class="programlisting">extern gss_OID GSS_C_NT_ANONYMOUS;
4531 </pre>
4532 </div>
4533 <hr>
4534 <div class="refsect2">
4535 <a name="GSS-C-NT-EXPORT-NAME:CAPS"></a><h3>GSS_C_NT_EXPORT_NAME</h3>
4536 <pre class="programlisting">extern gss_OID GSS_C_NT_EXPORT_NAME;
4537 </pre>
4538 </div>
4539 <hr>
4540 <div class="refsect2">
4541 <a name="GSS-S-COMPLETE:CAPS"></a><h3>GSS_S_COMPLETE</h3>
4542 <pre class="programlisting"># define GSS_S_COMPLETE 0
4543 </pre>
4544 </div>
4545 <hr>
4546 <div class="refsect2">
4547 <a name="GSS-C-CALLING-ERROR-OFFSET:CAPS"></a><h3>GSS_C_CALLING_ERROR_OFFSET</h3>
4548 <pre class="programlisting"># define GSS_C_CALLING_ERROR_OFFSET 24
4549 </pre>
4550 </div>
4551 <hr>
4552 <div class="refsect2">
4553 <a name="GSS-C-ROUTINE-ERROR-OFFSET:CAPS"></a><h3>GSS_C_ROUTINE_ERROR_OFFSET</h3>
4554 <pre class="programlisting"># define GSS_C_ROUTINE_ERROR_OFFSET 16
4555 </pre>
4556 </div>
4557 <hr>
4558 <div class="refsect2">
4559 <a name="GSS-C-SUPPLEMENTARY-OFFSET:CAPS"></a><h3>GSS_C_SUPPLEMENTARY_OFFSET</h3>
4560 <pre class="programlisting"># define GSS_C_SUPPLEMENTARY_OFFSET 0
4561 </pre>
4562 </div>
4563 <hr>
4564 <div class="refsect2">
4565 <a name="GSS-C-CALLING-ERROR-MASK:CAPS"></a><h3>GSS_C_CALLING_ERROR_MASK</h3>
4566 <pre class="programlisting"># define GSS_C_CALLING_ERROR_MASK 0377ul
4567 </pre>
4568 </div>
4569 <hr>
4570 <div class="refsect2">
4571 <a name="GSS-C-ROUTINE-ERROR-MASK:CAPS"></a><h3>GSS_C_ROUTINE_ERROR_MASK</h3>
4572 <pre class="programlisting"># define GSS_C_ROUTINE_ERROR_MASK 0377ul
4573 </pre>
4574 </div>
4575 <hr>
4576 <div class="refsect2">
4577 <a name="GSS-C-SUPPLEMENTARY-MASK:CAPS"></a><h3>GSS_C_SUPPLEMENTARY_MASK</h3>
4578 <pre class="programlisting"># define GSS_C_SUPPLEMENTARY_MASK 0177777ul
4579 </pre>
4580 </div>
4581 <hr>
4582 <div class="refsect2">
4583 <a name="GSS-S-CALL-INACCESSIBLE-READ:CAPS"></a><h3>GSS_S_CALL_INACCESSIBLE_READ</h3>
4584 <pre class="programlisting"># define GSS_S_CALL_INACCESSIBLE_READ (1ul &lt;&lt; GSS_C_CALLING_ERROR_OFFSET)
4585 </pre>
4586 </div>
4587 <hr>
4588 <div class="refsect2">
4589 <a name="GSS-S-CALL-INACCESSIBLE-WRITE:CAPS"></a><h3>GSS_S_CALL_INACCESSIBLE_WRITE</h3>
4590 <pre class="programlisting"># define GSS_S_CALL_INACCESSIBLE_WRITE (2ul &lt;&lt; GSS_C_CALLING_ERROR_OFFSET)
4591 </pre>
4592 </div>
4593 <hr>
4594 <div class="refsect2">
4595 <a name="GSS-S-CALL-BAD-STRUCTURE:CAPS"></a><h3>GSS_S_CALL_BAD_STRUCTURE</h3>
4596 <pre class="programlisting"># define GSS_S_CALL_BAD_STRUCTURE (3ul &lt;&lt; GSS_C_CALLING_ERROR_OFFSET)
4597 </pre>
4598 </div>
4599 <hr>
4600 <div class="refsect2">
4601 <a name="GSS-S-BAD-MECH:CAPS"></a><h3>GSS_S_BAD_MECH</h3>
4602 <pre class="programlisting"># define GSS_S_BAD_MECH (1ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4603 </pre>
4604 </div>
4605 <hr>
4606 <div class="refsect2">
4607 <a name="GSS-S-BAD-NAME:CAPS"></a><h3>GSS_S_BAD_NAME</h3>
4608 <pre class="programlisting"># define GSS_S_BAD_NAME (2ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4609 </pre>
4610 </div>
4611 <hr>
4612 <div class="refsect2">
4613 <a name="GSS-S-BAD-NAMETYPE:CAPS"></a><h3>GSS_S_BAD_NAMETYPE</h3>
4614 <pre class="programlisting"># define GSS_S_BAD_NAMETYPE (3ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4615 </pre>
4616 </div>
4617 <hr>
4618 <div class="refsect2">
4619 <a name="GSS-S-BAD-BINDINGS:CAPS"></a><h3>GSS_S_BAD_BINDINGS</h3>
4620 <pre class="programlisting"># define GSS_S_BAD_BINDINGS (4ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4621 </pre>
4622 </div>
4623 <hr>
4624 <div class="refsect2">
4625 <a name="GSS-S-BAD-STATUS:CAPS"></a><h3>GSS_S_BAD_STATUS</h3>
4626 <pre class="programlisting"># define GSS_S_BAD_STATUS (5ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4627 </pre>
4628 </div>
4629 <hr>
4630 <div class="refsect2">
4631 <a name="GSS-S-BAD-SIG:CAPS"></a><h3>GSS_S_BAD_SIG</h3>
4632 <pre class="programlisting"># define GSS_S_BAD_SIG (6ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4633 </pre>
4634 </div>
4635 <hr>
4636 <div class="refsect2">
4637 <a name="GSS-S-BAD-MIC:CAPS"></a><h3>GSS_S_BAD_MIC</h3>
4638 <pre class="programlisting"># define GSS_S_BAD_MIC GSS_S_BAD_SIG
4639 </pre>
4640 </div>
4641 <hr>
4642 <div class="refsect2">
4643 <a name="GSS-S-NO-CRED:CAPS"></a><h3>GSS_S_NO_CRED</h3>
4644 <pre class="programlisting"># define GSS_S_NO_CRED (7ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4645 </pre>
4646 </div>
4647 <hr>
4648 <div class="refsect2">
4649 <a name="GSS-S-NO-CONTEXT:CAPS"></a><h3>GSS_S_NO_CONTEXT</h3>
4650 <pre class="programlisting"># define GSS_S_NO_CONTEXT (8ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4651 </pre>
4652 </div>
4653 <hr>
4654 <div class="refsect2">
4655 <a name="GSS-S-DEFECTIVE-TOKEN:CAPS"></a><h3>GSS_S_DEFECTIVE_TOKEN</h3>
4656 <pre class="programlisting"># define GSS_S_DEFECTIVE_TOKEN (9ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4657 </pre>
4658 </div>
4659 <hr>
4660 <div class="refsect2">
4661 <a name="GSS-S-DEFECTIVE-CREDENTIAL:CAPS"></a><h3>GSS_S_DEFECTIVE_CREDENTIAL</h3>
4662 <pre class="programlisting"># define GSS_S_DEFECTIVE_CREDENTIAL (10ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4663 </pre>
4664 </div>
4665 <hr>
4666 <div class="refsect2">
4667 <a name="GSS-S-CREDENTIALS-EXPIRED:CAPS"></a><h3>GSS_S_CREDENTIALS_EXPIRED</h3>
4668 <pre class="programlisting"># define GSS_S_CREDENTIALS_EXPIRED (11ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4669 </pre>
4670 </div>
4671 <hr>
4672 <div class="refsect2">
4673 <a name="GSS-S-CONTEXT-EXPIRED:CAPS"></a><h3>GSS_S_CONTEXT_EXPIRED</h3>
4674 <pre class="programlisting"># define GSS_S_CONTEXT_EXPIRED (12ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4675 </pre>
4676 </div>
4677 <hr>
4678 <div class="refsect2">
4679 <a name="GSS-S-FAILURE:CAPS"></a><h3>GSS_S_FAILURE</h3>
4680 <pre class="programlisting"># define GSS_S_FAILURE (13ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4681 </pre>
4682 </div>
4683 <hr>
4684 <div class="refsect2">
4685 <a name="GSS-S-BAD-QOP:CAPS"></a><h3>GSS_S_BAD_QOP</h3>
4686 <pre class="programlisting"># define GSS_S_BAD_QOP (14ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4687 </pre>
4688 </div>
4689 <hr>
4690 <div class="refsect2">
4691 <a name="GSS-S-UNAUTHORIZED:CAPS"></a><h3>GSS_S_UNAUTHORIZED</h3>
4692 <pre class="programlisting"># define GSS_S_UNAUTHORIZED (15ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4693 </pre>
4694 </div>
4695 <hr>
4696 <div class="refsect2">
4697 <a name="GSS-S-UNAVAILABLE:CAPS"></a><h3>GSS_S_UNAVAILABLE</h3>
4698 <pre class="programlisting"># define GSS_S_UNAVAILABLE (16ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4699 </pre>
4700 </div>
4701 <hr>
4702 <div class="refsect2">
4703 <a name="GSS-S-DUPLICATE-ELEMENT:CAPS"></a><h3>GSS_S_DUPLICATE_ELEMENT</h3>
4704 <pre class="programlisting"># define GSS_S_DUPLICATE_ELEMENT (17ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4705 </pre>
4706 </div>
4707 <hr>
4708 <div class="refsect2">
4709 <a name="GSS-S-NAME-NOT-MN:CAPS"></a><h3>GSS_S_NAME_NOT_MN</h3>
4710 <pre class="programlisting"># define GSS_S_NAME_NOT_MN (18ul &lt;&lt; GSS_C_ROUTINE_ERROR_OFFSET)
4711 </pre>
4712 </div>
4713 <hr>
4714 <div class="refsect2">
4715 <a name="GSS-S-CONTINUE-NEEDED:CAPS"></a><h3>GSS_S_CONTINUE_NEEDED</h3>
4716 <pre class="programlisting"># define GSS_S_CONTINUE_NEEDED (1ul &lt;&lt; (GSS_C_SUPPLEMENTARY_OFFSET + 0))
4717 </pre>
4718 </div>
4719 <hr>
4720 <div class="refsect2">
4721 <a name="GSS-S-DUPLICATE-TOKEN:CAPS"></a><h3>GSS_S_DUPLICATE_TOKEN</h3>
4722 <pre class="programlisting"># define GSS_S_DUPLICATE_TOKEN (1ul &lt;&lt; (GSS_C_SUPPLEMENTARY_OFFSET + 1))
4723 </pre>
4724 </div>
4725 <hr>
4726 <div class="refsect2">
4727 <a name="GSS-S-OLD-TOKEN:CAPS"></a><h3>GSS_S_OLD_TOKEN</h3>
4728 <pre class="programlisting"># define GSS_S_OLD_TOKEN (1ul &lt;&lt; (GSS_C_SUPPLEMENTARY_OFFSET + 2))
4729 </pre>
4730 </div>
4731 <hr>
4732 <div class="refsect2">
4733 <a name="GSS-S-UNSEQ-TOKEN:CAPS"></a><h3>GSS_S_UNSEQ_TOKEN</h3>
4734 <pre class="programlisting"># define GSS_S_UNSEQ_TOKEN (1ul &lt;&lt; (GSS_C_SUPPLEMENTARY_OFFSET + 3))
4735 </pre>
4736 </div>
4737 <hr>
4738 <div class="refsect2">
4739 <a name="GSS-S-GAP-TOKEN:CAPS"></a><h3>GSS_S_GAP_TOKEN</h3>
4740 <pre class="programlisting"># define GSS_S_GAP_TOKEN (1ul &lt;&lt; (GSS_C_SUPPLEMENTARY_OFFSET + 4))
4741 </pre>
4742 </div>
4743 <hr>
4744 <div class="refsect2">
4745 <a name="gss-const-buffer-t"></a><h3>gss_const_buffer_t</h3>
4746 <pre class="programlisting">typedef const gss_buffer_desc *gss_const_buffer_t;
4747 </pre>
4748 </div>
4749 <hr>
4750 <div class="refsect2">
4751 <a name="gss-const-ctx-id-t"></a><h3>gss_const_ctx_id_t</h3>
4752 <pre class="programlisting">typedef const struct gss_ctx_id_struct *gss_const_ctx_id_t;
4753 </pre>
4754 </div>
4755 <hr>
4756 <div class="refsect2">
4757 <a name="gss-const-cred-id-t"></a><h3>gss_const_cred_id_t</h3>
4758 <pre class="programlisting">typedef const struct gss_cred_id_struct *gss_const_cred_id_t;
4759 </pre>
4760 </div>
4761 <hr>
4762 <div class="refsect2">
4763 <a name="gss-const-name-t"></a><h3>gss_const_name_t</h3>
4764 <pre class="programlisting">typedef const struct gss_name_struct *gss_const_name_t;
4765 </pre>
4766 </div>
4767 <hr>
4768 <div class="refsect2">
4769 <a name="gss-const-OID"></a><h3>gss_const_OID</h3>
4770 <pre class="programlisting">typedef const gss_OID_desc *gss_const_OID;
4771 </pre>
4772 </div>
4773 <hr>
4774 <div class="refsect2">
4775 <a name="gss-const-OID-set"></a><h3>gss_const_OID_set</h3>
4776 <pre class="programlisting">typedef const gss_OID_set_desc *gss_const_OID_set;
4777 </pre>
4778 </div>
4779 </div>
4780 </div>
4781 <div class="footer">
4782 <hr>Generated by GTK-Doc V1.33.1</div>
4783 </body>
4784 </html>