aboutsummaryrefslogtreecommitdiffstats
path: root/doc/doxyout/krb5/html/group__krb5__auth.html
blob: 84dfe61b84167fcd710d3becd409689a29f9d0c7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Heimdal Kerberos 5 authentication functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<p>
<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
</p>
<!-- end of header marker -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Heimdal Kerberos 5 authentication functions</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga92b082fa699694b353fa51675f2c2259"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#ga92b082fa699694b353fa51675f2c2259">krb5_rd_req_in_ctx_alloc</a> (krb5_context context, krb5_rd_req_in_ctx *ctx)</td></tr>
<tr class="separator:ga92b082fa699694b353fa51675f2c2259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga124150b9eea8b56a9b432cf5e7a8db07"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#ga124150b9eea8b56a9b432cf5e7a8db07">krb5_rd_req_in_set_keytab</a> (krb5_context context, krb5_rd_req_in_ctx in, krb5_keytab keytab)</td></tr>
<tr class="separator:ga124150b9eea8b56a9b432cf5e7a8db07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd6913bc77982a536168d9dd52df2363"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#gadd6913bc77982a536168d9dd52df2363">krb5_rd_req_in_set_pac_check</a> (krb5_context context, krb5_rd_req_in_ctx in, krb5_boolean flag)</td></tr>
<tr class="separator:gadd6913bc77982a536168d9dd52df2363"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1ffffee7558466d31c23b110c95aa7b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#gac1ffffee7558466d31c23b110c95aa7b">krb5_rd_req_out_get_server</a> (krb5_context context, krb5_rd_req_out_ctx out, krb5_principal *principal)</td></tr>
<tr class="separator:gac1ffffee7558466d31c23b110c95aa7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8a5460c599500c0d64e632341c8f74a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#gad8a5460c599500c0d64e632341c8f74a">krb5_rd_req_out_ctx_free</a> (krb5_context context, krb5_rd_req_out_ctx ctx)</td></tr>
<tr class="separator:gad8a5460c599500c0d64e632341c8f74a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga589cab7251a70a5addbf1af56313401e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx</a> (krb5_context context, krb5_auth_context *auth_context, const krb5_data *inbuf, krb5_const_principal server, krb5_rd_req_in_ctx inctx, krb5_rd_req_out_ctx *outctx)</td></tr>
<tr class="separator:ga589cab7251a70a5addbf1af56313401e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga589cab7251a70a5addbf1af56313401e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga589cab7251a70a5addbf1af56313401e">&#9670;&nbsp;</a></span>krb5_rd_req_ctx()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_ctx </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_auth_context *&#160;</td>
          <td class="paramname"><em>auth_context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const krb5_data *&#160;</td>
          <td class="paramname"><em>inbuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_const_principal&#160;</td>
          <td class="paramname"><em>server</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_in_ctx&#160;</td>
          <td class="paramname"><em>inctx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_out_ctx *&#160;</td>
          <td class="paramname"><em>outctx</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The core server function that verify application authentication requests from clients.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Keberos 5 context. </td></tr>
    <tr><td class="paramname">auth_context</td><td>the authentication context, can be NULL, then default values for the authentication context will used. </td></tr>
    <tr><td class="paramname">inbuf</td><td>the (AP-REQ) authentication buffer</td></tr>
    <tr><td class="paramname">server</td><td>the server to authenticate to. If NULL the function will try to find any available credential in the keytab that will verify the reply. The function will prefer the server specified in the AP-REQ, but if there is no mach, it will try all keytab entries for a match. This has serious performance issues for large keytabs.</td></tr>
    <tr><td class="paramname">inctx</td><td>control the behavior of the function, if NULL, the default behavior is used. </td></tr>
    <tr><td class="paramname">outctx</td><td>the return outctx, free with <a class="el" href="group__krb5__auth.html#gad8a5460c599500c0d64e632341c8f74a">krb5_rd_req_out_ctx_free()</a>. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>

</div>
</div>
<a id="ga92b082fa699694b353fa51675f2c2259"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92b082fa699694b353fa51675f2c2259">&#9670;&nbsp;</a></span>krb5_rd_req_in_ctx_alloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_ctx_alloc </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_in_ctx *&#160;</td>
          <td class="paramname"><em>ctx</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Allocate a krb5_rd_req_in_ctx as an input parameter to <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a>. The caller should free the context with krb5_rd_req_in_ctx_free() when done with the context.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Keberos 5 context. </td></tr>
    <tr><td class="paramname">ctx</td><td>in ctx to <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>

</div>
</div>
<a id="ga124150b9eea8b56a9b432cf5e7a8db07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga124150b9eea8b56a9b432cf5e7a8db07">&#9670;&nbsp;</a></span>krb5_rd_req_in_set_keytab()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_set_keytab </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_in_ctx&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_keytab&#160;</td>
          <td class="paramname"><em>keytab</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the keytab that <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a> will use.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Keberos 5 context. </td></tr>
    <tr><td class="paramname">in</td><td>in ctx to <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a>. </td></tr>
    <tr><td class="paramname">keytab</td><td>keytab that <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a> will use, only copy the pointer, so the caller must free they keytab after krb5_rd_req_in_ctx_free() is called.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>

</div>
</div>
<a id="gadd6913bc77982a536168d9dd52df2363"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd6913bc77982a536168d9dd52df2363">&#9670;&nbsp;</a></span>krb5_rd_req_in_set_pac_check()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_in_set_pac_check </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_in_ctx&#160;</td>
          <td class="paramname"><em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_boolean&#160;</td>
          <td class="paramname"><em>flag</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set if krb5_rq_red() is going to check the Windows PAC or not</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Keberos 5 context. </td></tr>
    <tr><td class="paramname">in</td><td>krb5_rd_req_in_ctx to check the option on. </td></tr>
    <tr><td class="paramname">flag</td><td>flag to select if to check the pac (TRUE) or not (FALSE).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>

</div>
</div>
<a id="gad8a5460c599500c0d64e632341c8f74a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad8a5460c599500c0d64e632341c8f74a">&#9670;&nbsp;</a></span>krb5_rd_req_out_ctx_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_rd_req_out_ctx_free </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_out_ctx&#160;</td>
          <td class="paramname"><em>ctx</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Free the krb5_rd_req_out_ctx.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Keberos 5 context. </td></tr>
    <tr><td class="paramname">ctx</td><td>krb5_rd_req_out_ctx context to free. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac1ffffee7558466d31c23b110c95aa7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1ffffee7558466d31c23b110c95aa7b">&#9670;&nbsp;</a></span>krb5_rd_req_out_get_server()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_rd_req_out_get_server </td>
          <td>(</td>
          <td class="paramtype">krb5_context&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_rd_req_out_ctx&#160;</td>
          <td class="paramname"><em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">krb5_principal *&#160;</td>
          <td class="paramname"><em>principal</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the principal that was used in the request from the client. Might not match whats in the ticket if <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a> searched in the keytab for a matching key.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr>
    <tr><td class="paramname">out</td><td>a krb5_rd_req_out_ctx from <a class="el" href="group__krb5__auth.html#ga589cab7251a70a5addbf1af56313401e">krb5_rd_req_ctx()</a>. </td></tr>
    <tr><td class="paramname">principal</td><td>return principal, free with <a class="el" href="group__krb5__principal.html#ga5bd3f620ebe8cd4fe44b5c858ba17d22">krb5_free_principal()</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated on Fri Dec 8 2017 03:48:59 for HeimdalKerberos5library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.13</small></address>
</body>
</html>