xref: /freebsd/crypto/heimdal/doc/doxyout/krb5/html/group__krb5__address.html (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>HeimdalKerberos5library: Heimdal Kerberos 5 address functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<p>
8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
9</p>
10<!-- end of header marker -->
11<!-- Generated by Doxygen 1.5.6 -->
12<div class="navigation" id="top">
13  <div class="tabs">
14    <ul>
15      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
16      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
17      <li><a href="modules.html"><span>Modules</span></a></li>
18      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
19    </ul>
20  </div>
21</div>
22<div class="contents">
23<h1>Heimdal Kerberos 5 address functions</h1><table border="0" cellpadding="0" cellspacing="0">
24<tr><td></td></tr>
25<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
27krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gec34704845bdaee3c08ebba2fa87d61e">krb5_sockaddr2address</a> (krb5_context context, const struct sockaddr *sa, krb5_address *addr)</td></tr>
28
29<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
30krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g76125115a2c040a3f70a4f66eada77aa">krb5_sockaddr2port</a> (krb5_context context, const struct sockaddr *sa, int16_t *port)</td></tr>
31
32<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
33krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g88b9c3052f35dc5a44fdfe9747c36cc5">krb5_addr2sockaddr</a> (krb5_context context, const krb5_address *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)</td></tr>
34
35<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION size_t <br>
36KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g55bd20d9a185cf7963e2117c1c804c85">krb5_max_sockaddr_size</a> (void)</td></tr>
37
38<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean <br>
39KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gc4c55c7ef3d078993b0177649593088c">krb5_sockaddr_uninteresting</a> (const struct sockaddr *sa)</td></tr>
40
41<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
42krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g51cd06ac365188aa989256b99b706f80">krb5_h_addr2sockaddr</a> (krb5_context context, int af, const char *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)</td></tr>
43
44<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
45krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gb8901409302e9e7bb95187e4d5e6a179">krb5_h_addr2addr</a> (krb5_context context, int af, const char *haddr, krb5_address *addr)</td></tr>
46
47<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
48krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g9cfbb00b2bed85766f86b63541cc7752">krb5_anyaddr</a> (krb5_context context, int af, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)</td></tr>
49
50<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
51krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g6e9adff4c8738f92fa2637698c06ccb9">krb5_print_address</a> (const krb5_address *addr, char *str, size_t len, size_t *ret_len)</td></tr>
52
53<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
54krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gd7bc7e348e6d36c4cf09dcd2ee5a92a3">krb5_parse_address</a> (krb5_context context, const char *string, krb5_addresses *addresses)</td></tr>
55
56<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION int KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gc743b9d3c7e4a1f71659ffd28b1fd9fb">krb5_address_order</a> (krb5_context context, const krb5_address *addr1, const krb5_address *addr2)</td></tr>
57
58<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean <br>
59KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g7771724e9a25914395dabac15b705e33">krb5_address_compare</a> (krb5_context context, const krb5_address *addr1, const krb5_address *addr2)</td></tr>
60
61<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean <br>
62KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#ge2720bd07b737e73c8b6924403e5b7e1">krb5_address_search</a> (krb5_context context, const krb5_address *addr, const krb5_addresses *addrlist)</td></tr>
63
64<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
65krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g705d91f9f2a2311b656371e553af66a3">krb5_free_address</a> (krb5_context context, krb5_address *address)</td></tr>
66
67<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
68krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g3b5f1c170a4af0de561bc30486983cc5">krb5_free_addresses</a> (krb5_context context, krb5_addresses *addresses)</td></tr>
69
70<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
71krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gf965da6155d3b086a6ca2e47b391f5df">krb5_copy_address</a> (krb5_context context, const krb5_address *inaddr, krb5_address *outaddr)</td></tr>
72
73<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
74krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g8b73a9ee0e1259a7f10809b329483b85">krb5_copy_addresses</a> (krb5_context context, const krb5_addresses *inaddr, krb5_addresses *outaddr)</td></tr>
75
76<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
77krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gf56d02edcc81b3edd3c5a1e2e16e99e3">krb5_append_addresses</a> (krb5_context context, krb5_addresses *dest, const krb5_addresses *source)</td></tr>
78
79<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
80krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#gc50ffb71832862424c35c1ace9bbe14d">krb5_make_addrport</a> (krb5_context context, krb5_address **res, const krb5_address *addr, int16_t port)</td></tr>
81
82<tr><td class="memItemLeft" nowrap align="right" valign="top">KRB5_LIB_FUNCTION <br>
83krb5_error_code KRB5_LIB_CALL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__address.html#g3164f6fcff3b1029b93d316e14b017cf">krb5_address_prefixlen_boundary</a> (krb5_context context, const krb5_address *inaddr, unsigned long prefixlen, krb5_address *low, krb5_address *high)</td></tr>
84
85</table>
86<hr><a name="_details"></a><h2>Detailed Description</h2>
87<hr><h2>Function Documentation</h2>
88<a class="anchor" name="g88b9c3052f35dc5a44fdfe9747c36cc5"></a><!-- doxytag: member="addr_families.c::krb5_addr2sockaddr" ref="g88b9c3052f35dc5a44fdfe9747c36cc5" args="(krb5_context context, const krb5_address *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)" -->
89<div class="memitem">
90<div class="memproto">
91      <table class="memname">
92        <tr>
93          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_addr2sockaddr           </td>
94          <td>(</td>
95          <td class="paramtype">krb5_context&nbsp;</td>
96          <td class="paramname"> <em>context</em>, </td>
97        </tr>
98        <tr>
99          <td class="paramkey"></td>
100          <td></td>
101          <td class="paramtype">const krb5_address *&nbsp;</td>
102          <td class="paramname"> <em>addr</em>, </td>
103        </tr>
104        <tr>
105          <td class="paramkey"></td>
106          <td></td>
107          <td class="paramtype">struct sockaddr *&nbsp;</td>
108          <td class="paramname"> <em>sa</em>, </td>
109        </tr>
110        <tr>
111          <td class="paramkey"></td>
112          <td></td>
113          <td class="paramtype">krb5_socklen_t *&nbsp;</td>
114          <td class="paramname"> <em>sa_size</em>, </td>
115        </tr>
116        <tr>
117          <td class="paramkey"></td>
118          <td></td>
119          <td class="paramtype">int&nbsp;</td>
120          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
121        </tr>
122        <tr>
123          <td></td>
124          <td>)</td>
125          <td></td><td></td><td></td>
126        </tr>
127      </table>
128</div>
129<div class="memdoc">
130
131<p>
132krb5_addr2sockaddr sets the "struct sockaddr sockaddr" from addr and port. The argument sa_size should initially contain the size of the sa and after the call, it will contain the actual length of the address. In case of the sa is too small to fit the whole address, the up to *sa_size will be stored, and then *sa_size will be set to the required length.<p>
133<dl compact><dt><b>Parameters:</b></dt><dd>
134  <table border="0" cellspacing="2" cellpadding="0">
135    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
136    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>the address to copy the from </td></tr>
137    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>the struct sockaddr that will be filled in </td></tr>
138    <tr><td valign="top"></td><td valign="top"><em>sa_size</em>&nbsp;</td><td>pointer to length of sa, and after the call, it will contain the actual length of the address. </td></tr>
139    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>set port in sa.</td></tr>
140  </table>
141</dl>
142<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. Will return KRB5_PROG_ATYPE_NOSUPP in case address type is not supported. </dd></dl>
143
144</div>
145</div><p>
146<a class="anchor" name="g7771724e9a25914395dabac15b705e33"></a><!-- doxytag: member="addr_families.c::krb5_address_compare" ref="g7771724e9a25914395dabac15b705e33" args="(krb5_context context, const krb5_address *addr1, const krb5_address *addr2)" -->
147<div class="memitem">
148<div class="memproto">
149      <table class="memname">
150        <tr>
151          <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_address_compare           </td>
152          <td>(</td>
153          <td class="paramtype">krb5_context&nbsp;</td>
154          <td class="paramname"> <em>context</em>, </td>
155        </tr>
156        <tr>
157          <td class="paramkey"></td>
158          <td></td>
159          <td class="paramtype">const krb5_address *&nbsp;</td>
160          <td class="paramname"> <em>addr1</em>, </td>
161        </tr>
162        <tr>
163          <td class="paramkey"></td>
164          <td></td>
165          <td class="paramtype">const krb5_address *&nbsp;</td>
166          <td class="paramname"> <em>addr2</em></td><td>&nbsp;</td>
167        </tr>
168        <tr>
169          <td></td>
170          <td>)</td>
171          <td></td><td></td><td></td>
172        </tr>
173      </table>
174</div>
175<div class="memdoc">
176
177<p>
178krb5_address_compare compares the addresses addr1 and addr2. Returns TRUE if the two addresses are the same.<p>
179<dl compact><dt><b>Parameters:</b></dt><dd>
180  <table border="0" cellspacing="2" cellpadding="0">
181    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
182    <tr><td valign="top"></td><td valign="top"><em>addr1</em>&nbsp;</td><td>address to compare </td></tr>
183    <tr><td valign="top"></td><td valign="top"><em>addr2</em>&nbsp;</td><td>address to compare</td></tr>
184  </table>
185</dl>
186<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an TRUE is the address are the same FALSE if not </dd></dl>
187
188</div>
189</div><p>
190<a class="anchor" name="gc743b9d3c7e4a1f71659ffd28b1fd9fb"></a><!-- doxytag: member="addr_families.c::krb5_address_order" ref="gc743b9d3c7e4a1f71659ffd28b1fd9fb" args="(krb5_context context, const krb5_address *addr1, const krb5_address *addr2)" -->
191<div class="memitem">
192<div class="memproto">
193      <table class="memname">
194        <tr>
195          <td class="memname">KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_address_order           </td>
196          <td>(</td>
197          <td class="paramtype">krb5_context&nbsp;</td>
198          <td class="paramname"> <em>context</em>, </td>
199        </tr>
200        <tr>
201          <td class="paramkey"></td>
202          <td></td>
203          <td class="paramtype">const krb5_address *&nbsp;</td>
204          <td class="paramname"> <em>addr1</em>, </td>
205        </tr>
206        <tr>
207          <td class="paramkey"></td>
208          <td></td>
209          <td class="paramtype">const krb5_address *&nbsp;</td>
210          <td class="paramname"> <em>addr2</em></td><td>&nbsp;</td>
211        </tr>
212        <tr>
213          <td></td>
214          <td>)</td>
215          <td></td><td></td><td></td>
216        </tr>
217      </table>
218</div>
219<div class="memdoc">
220
221<p>
222krb5_address_order compares the addresses addr1 and addr2 so that it can be used for sorting addresses. If the addresses are the same address krb5_address_order will return 0. Behavies like memcmp(2).<p>
223<dl compact><dt><b>Parameters:</b></dt><dd>
224  <table border="0" cellspacing="2" cellpadding="0">
225    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
226    <tr><td valign="top"></td><td valign="top"><em>addr1</em>&nbsp;</td><td>krb5_address to compare </td></tr>
227    <tr><td valign="top"></td><td valign="top"><em>addr2</em>&nbsp;</td><td>krb5_address to compare</td></tr>
228  </table>
229</dl>
230<dl class="return" compact><dt><b>Returns:</b></dt><dd>&lt; 0 if address addr1 in "less" then addr2. 0 if addr1 and addr2 is the same address, &gt; 0 if addr2 is "less" then addr1. </dd></dl>
231
232</div>
233</div><p>
234<a class="anchor" name="g3164f6fcff3b1029b93d316e14b017cf"></a><!-- doxytag: member="addr_families.c::krb5_address_prefixlen_boundary" ref="g3164f6fcff3b1029b93d316e14b017cf" args="(krb5_context context, const krb5_address *inaddr, unsigned long prefixlen, krb5_address *low, krb5_address *high)" -->
235<div class="memitem">
236<div class="memproto">
237      <table class="memname">
238        <tr>
239          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_address_prefixlen_boundary           </td>
240          <td>(</td>
241          <td class="paramtype">krb5_context&nbsp;</td>
242          <td class="paramname"> <em>context</em>, </td>
243        </tr>
244        <tr>
245          <td class="paramkey"></td>
246          <td></td>
247          <td class="paramtype">const krb5_address *&nbsp;</td>
248          <td class="paramname"> <em>inaddr</em>, </td>
249        </tr>
250        <tr>
251          <td class="paramkey"></td>
252          <td></td>
253          <td class="paramtype">unsigned long&nbsp;</td>
254          <td class="paramname"> <em>prefixlen</em>, </td>
255        </tr>
256        <tr>
257          <td class="paramkey"></td>
258          <td></td>
259          <td class="paramtype">krb5_address *&nbsp;</td>
260          <td class="paramname"> <em>low</em>, </td>
261        </tr>
262        <tr>
263          <td class="paramkey"></td>
264          <td></td>
265          <td class="paramtype">krb5_address *&nbsp;</td>
266          <td class="paramname"> <em>high</em></td><td>&nbsp;</td>
267        </tr>
268        <tr>
269          <td></td>
270          <td>)</td>
271          <td></td><td></td><td></td>
272        </tr>
273      </table>
274</div>
275<div class="memdoc">
276
277<p>
278Calculate the boundary addresses of `inaddr'/`prefixlen' and store them in `low' and `high'.<p>
279<dl compact><dt><b>Parameters:</b></dt><dd>
280  <table border="0" cellspacing="2" cellpadding="0">
281    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
282    <tr><td valign="top"></td><td valign="top"><em>inaddr</em>&nbsp;</td><td>address in prefixlen that the bondery searched </td></tr>
283    <tr><td valign="top"></td><td valign="top"><em>prefixlen</em>&nbsp;</td><td>width of boundery </td></tr>
284    <tr><td valign="top"></td><td valign="top"><em>low</em>&nbsp;</td><td>lowest address </td></tr>
285    <tr><td valign="top"></td><td valign="top"><em>high</em>&nbsp;</td><td>highest address</td></tr>
286  </table>
287</dl>
288<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
289
290</div>
291</div><p>
292<a class="anchor" name="ge2720bd07b737e73c8b6924403e5b7e1"></a><!-- doxytag: member="addr_families.c::krb5_address_search" ref="ge2720bd07b737e73c8b6924403e5b7e1" args="(krb5_context context, const krb5_address *addr, const krb5_addresses *addrlist)" -->
293<div class="memitem">
294<div class="memproto">
295      <table class="memname">
296        <tr>
297          <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_address_search           </td>
298          <td>(</td>
299          <td class="paramtype">krb5_context&nbsp;</td>
300          <td class="paramname"> <em>context</em>, </td>
301        </tr>
302        <tr>
303          <td class="paramkey"></td>
304          <td></td>
305          <td class="paramtype">const krb5_address *&nbsp;</td>
306          <td class="paramname"> <em>addr</em>, </td>
307        </tr>
308        <tr>
309          <td class="paramkey"></td>
310          <td></td>
311          <td class="paramtype">const krb5_addresses *&nbsp;</td>
312          <td class="paramname"> <em>addrlist</em></td><td>&nbsp;</td>
313        </tr>
314        <tr>
315          <td></td>
316          <td>)</td>
317          <td></td><td></td><td></td>
318        </tr>
319      </table>
320</div>
321<div class="memdoc">
322
323<p>
324krb5_address_search checks if the address addr is a member of the address set list addrlist .<p>
325<dl compact><dt><b>Parameters:</b></dt><dd>
326  <table border="0" cellspacing="2" cellpadding="0">
327    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context. </td></tr>
328    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>address to search for. </td></tr>
329    <tr><td valign="top"></td><td valign="top"><em>addrlist</em>&nbsp;</td><td>list of addresses to look in for addr.</td></tr>
330  </table>
331</dl>
332<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
333
334</div>
335</div><p>
336<a class="anchor" name="g9cfbb00b2bed85766f86b63541cc7752"></a><!-- doxytag: member="addr_families.c::krb5_anyaddr" ref="g9cfbb00b2bed85766f86b63541cc7752" args="(krb5_context context, int af, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)" -->
337<div class="memitem">
338<div class="memproto">
339      <table class="memname">
340        <tr>
341          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_anyaddr           </td>
342          <td>(</td>
343          <td class="paramtype">krb5_context&nbsp;</td>
344          <td class="paramname"> <em>context</em>, </td>
345        </tr>
346        <tr>
347          <td class="paramkey"></td>
348          <td></td>
349          <td class="paramtype">int&nbsp;</td>
350          <td class="paramname"> <em>af</em>, </td>
351        </tr>
352        <tr>
353          <td class="paramkey"></td>
354          <td></td>
355          <td class="paramtype">struct sockaddr *&nbsp;</td>
356          <td class="paramname"> <em>sa</em>, </td>
357        </tr>
358        <tr>
359          <td class="paramkey"></td>
360          <td></td>
361          <td class="paramtype">krb5_socklen_t *&nbsp;</td>
362          <td class="paramname"> <em>sa_size</em>, </td>
363        </tr>
364        <tr>
365          <td class="paramkey"></td>
366          <td></td>
367          <td class="paramtype">int&nbsp;</td>
368          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
369        </tr>
370        <tr>
371          <td></td>
372          <td>)</td>
373          <td></td><td></td><td></td>
374        </tr>
375      </table>
376</div>
377<div class="memdoc">
378
379<p>
380krb5_anyaddr fills in a "struct sockaddr sa" that can be used to bind(2) to. The argument sa_size should initially contain the size of the sa, and after the call, it will contain the actual length of the address.<p>
381<dl compact><dt><b>Parameters:</b></dt><dd>
382  <table border="0" cellspacing="2" cellpadding="0">
383    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
384    <tr><td valign="top"></td><td valign="top"><em>af</em>&nbsp;</td><td>address family </td></tr>
385    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>sockaddr </td></tr>
386    <tr><td valign="top"></td><td valign="top"><em>sa_size</em>&nbsp;</td><td>lenght of sa. </td></tr>
387    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>for to fill into sa.</td></tr>
388  </table>
389</dl>
390<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
391
392</div>
393</div><p>
394<a class="anchor" name="gf56d02edcc81b3edd3c5a1e2e16e99e3"></a><!-- doxytag: member="addr_families.c::krb5_append_addresses" ref="gf56d02edcc81b3edd3c5a1e2e16e99e3" args="(krb5_context context, krb5_addresses *dest, const krb5_addresses *source)" -->
395<div class="memitem">
396<div class="memproto">
397      <table class="memname">
398        <tr>
399          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_append_addresses           </td>
400          <td>(</td>
401          <td class="paramtype">krb5_context&nbsp;</td>
402          <td class="paramname"> <em>context</em>, </td>
403        </tr>
404        <tr>
405          <td class="paramkey"></td>
406          <td></td>
407          <td class="paramtype">krb5_addresses *&nbsp;</td>
408          <td class="paramname"> <em>dest</em>, </td>
409        </tr>
410        <tr>
411          <td class="paramkey"></td>
412          <td></td>
413          <td class="paramtype">const krb5_addresses *&nbsp;</td>
414          <td class="paramname"> <em>source</em></td><td>&nbsp;</td>
415        </tr>
416        <tr>
417          <td></td>
418          <td>)</td>
419          <td></td><td></td><td></td>
420        </tr>
421      </table>
422</div>
423<div class="memdoc">
424
425<p>
426krb5_append_addresses adds the set of addresses in source to dest. While copying the addresses, duplicates are also sorted out.<p>
427<dl compact><dt><b>Parameters:</b></dt><dd>
428  <table border="0" cellspacing="2" cellpadding="0">
429    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
430    <tr><td valign="top"></td><td valign="top"><em>dest</em>&nbsp;</td><td>destination of copy operation </td></tr>
431    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>adresses that are going to be added to dest</td></tr>
432  </table>
433</dl>
434<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
435
436</div>
437</div><p>
438<a class="anchor" name="gf965da6155d3b086a6ca2e47b391f5df"></a><!-- doxytag: member="addr_families.c::krb5_copy_address" ref="gf965da6155d3b086a6ca2e47b391f5df" args="(krb5_context context, const krb5_address *inaddr, krb5_address *outaddr)" -->
439<div class="memitem">
440<div class="memproto">
441      <table class="memname">
442        <tr>
443          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_address           </td>
444          <td>(</td>
445          <td class="paramtype">krb5_context&nbsp;</td>
446          <td class="paramname"> <em>context</em>, </td>
447        </tr>
448        <tr>
449          <td class="paramkey"></td>
450          <td></td>
451          <td class="paramtype">const krb5_address *&nbsp;</td>
452          <td class="paramname"> <em>inaddr</em>, </td>
453        </tr>
454        <tr>
455          <td class="paramkey"></td>
456          <td></td>
457          <td class="paramtype">krb5_address *&nbsp;</td>
458          <td class="paramname"> <em>outaddr</em></td><td>&nbsp;</td>
459        </tr>
460        <tr>
461          <td></td>
462          <td>)</td>
463          <td></td><td></td><td></td>
464        </tr>
465      </table>
466</div>
467<div class="memdoc">
468
469<p>
470krb5_copy_address copies the content of address inaddr to outaddr.<p>
471<dl compact><dt><b>Parameters:</b></dt><dd>
472  <table border="0" cellspacing="2" cellpadding="0">
473    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
474    <tr><td valign="top"></td><td valign="top"><em>inaddr</em>&nbsp;</td><td>pointer to source address </td></tr>
475    <tr><td valign="top"></td><td valign="top"><em>outaddr</em>&nbsp;</td><td>pointer to destination address</td></tr>
476  </table>
477</dl>
478<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
479
480</div>
481</div><p>
482<a class="anchor" name="g8b73a9ee0e1259a7f10809b329483b85"></a><!-- doxytag: member="addr_families.c::krb5_copy_addresses" ref="g8b73a9ee0e1259a7f10809b329483b85" args="(krb5_context context, const krb5_addresses *inaddr, krb5_addresses *outaddr)" -->
483<div class="memitem">
484<div class="memproto">
485      <table class="memname">
486        <tr>
487          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_addresses           </td>
488          <td>(</td>
489          <td class="paramtype">krb5_context&nbsp;</td>
490          <td class="paramname"> <em>context</em>, </td>
491        </tr>
492        <tr>
493          <td class="paramkey"></td>
494          <td></td>
495          <td class="paramtype">const krb5_addresses *&nbsp;</td>
496          <td class="paramname"> <em>inaddr</em>, </td>
497        </tr>
498        <tr>
499          <td class="paramkey"></td>
500          <td></td>
501          <td class="paramtype">krb5_addresses *&nbsp;</td>
502          <td class="paramname"> <em>outaddr</em></td><td>&nbsp;</td>
503        </tr>
504        <tr>
505          <td></td>
506          <td>)</td>
507          <td></td><td></td><td></td>
508        </tr>
509      </table>
510</div>
511<div class="memdoc">
512
513<p>
514krb5_copy_addresses copies the content of addresses inaddr to outaddr.<p>
515<dl compact><dt><b>Parameters:</b></dt><dd>
516  <table border="0" cellspacing="2" cellpadding="0">
517    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
518    <tr><td valign="top"></td><td valign="top"><em>inaddr</em>&nbsp;</td><td>pointer to source addresses </td></tr>
519    <tr><td valign="top"></td><td valign="top"><em>outaddr</em>&nbsp;</td><td>pointer to destination addresses</td></tr>
520  </table>
521</dl>
522<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
523
524</div>
525</div><p>
526<a class="anchor" name="g705d91f9f2a2311b656371e553af66a3"></a><!-- doxytag: member="addr_families.c::krb5_free_address" ref="g705d91f9f2a2311b656371e553af66a3" args="(krb5_context context, krb5_address *address)" -->
527<div class="memitem">
528<div class="memproto">
529      <table class="memname">
530        <tr>
531          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_address           </td>
532          <td>(</td>
533          <td class="paramtype">krb5_context&nbsp;</td>
534          <td class="paramname"> <em>context</em>, </td>
535        </tr>
536        <tr>
537          <td class="paramkey"></td>
538          <td></td>
539          <td class="paramtype">krb5_address *&nbsp;</td>
540          <td class="paramname"> <em>address</em></td><td>&nbsp;</td>
541        </tr>
542        <tr>
543          <td></td>
544          <td>)</td>
545          <td></td><td></td><td></td>
546        </tr>
547      </table>
548</div>
549<div class="memdoc">
550
551<p>
552krb5_free_address frees the data stored in the address that is alloced with any of the krb5_address functions.<p>
553<dl compact><dt><b>Parameters:</b></dt><dd>
554  <table border="0" cellspacing="2" cellpadding="0">
555    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
556    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>addresss to be freed.</td></tr>
557  </table>
558</dl>
559<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
560
561</div>
562</div><p>
563<a class="anchor" name="g3b5f1c170a4af0de561bc30486983cc5"></a><!-- doxytag: member="addr_families.c::krb5_free_addresses" ref="g3b5f1c170a4af0de561bc30486983cc5" args="(krb5_context context, krb5_addresses *addresses)" -->
564<div class="memitem">
565<div class="memproto">
566      <table class="memname">
567        <tr>
568          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_addresses           </td>
569          <td>(</td>
570          <td class="paramtype">krb5_context&nbsp;</td>
571          <td class="paramname"> <em>context</em>, </td>
572        </tr>
573        <tr>
574          <td class="paramkey"></td>
575          <td></td>
576          <td class="paramtype">krb5_addresses *&nbsp;</td>
577          <td class="paramname"> <em>addresses</em></td><td>&nbsp;</td>
578        </tr>
579        <tr>
580          <td></td>
581          <td>)</td>
582          <td></td><td></td><td></td>
583        </tr>
584      </table>
585</div>
586<div class="memdoc">
587
588<p>
589krb5_free_addresses frees the data stored in the address that is alloced with any of the krb5_address functions.<p>
590<dl compact><dt><b>Parameters:</b></dt><dd>
591  <table border="0" cellspacing="2" cellpadding="0">
592    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
593    <tr><td valign="top"></td><td valign="top"><em>addresses</em>&nbsp;</td><td>addressses to be freed.</td></tr>
594  </table>
595</dl>
596<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
597
598</div>
599</div><p>
600<a class="anchor" name="gb8901409302e9e7bb95187e4d5e6a179"></a><!-- doxytag: member="addr_families.c::krb5_h_addr2addr" ref="gb8901409302e9e7bb95187e4d5e6a179" args="(krb5_context context, int af, const char *haddr, krb5_address *addr)" -->
601<div class="memitem">
602<div class="memproto">
603      <table class="memname">
604        <tr>
605          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_addr2addr           </td>
606          <td>(</td>
607          <td class="paramtype">krb5_context&nbsp;</td>
608          <td class="paramname"> <em>context</em>, </td>
609        </tr>
610        <tr>
611          <td class="paramkey"></td>
612          <td></td>
613          <td class="paramtype">int&nbsp;</td>
614          <td class="paramname"> <em>af</em>, </td>
615        </tr>
616        <tr>
617          <td class="paramkey"></td>
618          <td></td>
619          <td class="paramtype">const char *&nbsp;</td>
620          <td class="paramname"> <em>haddr</em>, </td>
621        </tr>
622        <tr>
623          <td class="paramkey"></td>
624          <td></td>
625          <td class="paramtype">krb5_address *&nbsp;</td>
626          <td class="paramname"> <em>addr</em></td><td>&nbsp;</td>
627        </tr>
628        <tr>
629          <td></td>
630          <td>)</td>
631          <td></td><td></td><td></td>
632        </tr>
633      </table>
634</div>
635<div class="memdoc">
636
637<p>
638krb5_h_addr2addr works like krb5_h_addr2sockaddr with the exception that it operates on a krb5_address instead of a struct sockaddr.<p>
639<dl compact><dt><b>Parameters:</b></dt><dd>
640  <table border="0" cellspacing="2" cellpadding="0">
641    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
642    <tr><td valign="top"></td><td valign="top"><em>af</em>&nbsp;</td><td>address family </td></tr>
643    <tr><td valign="top"></td><td valign="top"><em>haddr</em>&nbsp;</td><td>host address from struct hostent. </td></tr>
644    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>returned krb5_address.</td></tr>
645  </table>
646</dl>
647<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
648
649</div>
650</div><p>
651<a class="anchor" name="g51cd06ac365188aa989256b99b706f80"></a><!-- doxytag: member="addr_families.c::krb5_h_addr2sockaddr" ref="g51cd06ac365188aa989256b99b706f80" args="(krb5_context context, int af, const char *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)" -->
652<div class="memitem">
653<div class="memproto">
654      <table class="memname">
655        <tr>
656          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_addr2sockaddr           </td>
657          <td>(</td>
658          <td class="paramtype">krb5_context&nbsp;</td>
659          <td class="paramname"> <em>context</em>, </td>
660        </tr>
661        <tr>
662          <td class="paramkey"></td>
663          <td></td>
664          <td class="paramtype">int&nbsp;</td>
665          <td class="paramname"> <em>af</em>, </td>
666        </tr>
667        <tr>
668          <td class="paramkey"></td>
669          <td></td>
670          <td class="paramtype">const char *&nbsp;</td>
671          <td class="paramname"> <em>addr</em>, </td>
672        </tr>
673        <tr>
674          <td class="paramkey"></td>
675          <td></td>
676          <td class="paramtype">struct sockaddr *&nbsp;</td>
677          <td class="paramname"> <em>sa</em>, </td>
678        </tr>
679        <tr>
680          <td class="paramkey"></td>
681          <td></td>
682          <td class="paramtype">krb5_socklen_t *&nbsp;</td>
683          <td class="paramname"> <em>sa_size</em>, </td>
684        </tr>
685        <tr>
686          <td class="paramkey"></td>
687          <td></td>
688          <td class="paramtype">int&nbsp;</td>
689          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
690        </tr>
691        <tr>
692          <td></td>
693          <td>)</td>
694          <td></td><td></td><td></td>
695        </tr>
696      </table>
697</div>
698<div class="memdoc">
699
700<p>
701krb5_h_addr2sockaddr initializes a "struct sockaddr sa" from af and the "struct hostent" (see gethostbyname(3) ) h_addr_list component. The argument sa_size should initially contain the size of the sa, and after the call, it will contain the actual length of the address.<p>
702<dl compact><dt><b>Parameters:</b></dt><dd>
703  <table border="0" cellspacing="2" cellpadding="0">
704    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
705    <tr><td valign="top"></td><td valign="top"><em>af</em>&nbsp;</td><td>addresses </td></tr>
706    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>address </td></tr>
707    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>returned struct sockaddr </td></tr>
708    <tr><td valign="top"></td><td valign="top"><em>sa_size</em>&nbsp;</td><td>size of sa </td></tr>
709    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>port to set in sa.</td></tr>
710  </table>
711</dl>
712<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
713
714</div>
715</div><p>
716<a class="anchor" name="gc50ffb71832862424c35c1ace9bbe14d"></a><!-- doxytag: member="addr_families.c::krb5_make_addrport" ref="gc50ffb71832862424c35c1ace9bbe14d" args="(krb5_context context, krb5_address **res, const krb5_address *addr, int16_t port)" -->
717<div class="memitem">
718<div class="memproto">
719      <table class="memname">
720        <tr>
721          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_make_addrport           </td>
722          <td>(</td>
723          <td class="paramtype">krb5_context&nbsp;</td>
724          <td class="paramname"> <em>context</em>, </td>
725        </tr>
726        <tr>
727          <td class="paramkey"></td>
728          <td></td>
729          <td class="paramtype">krb5_address **&nbsp;</td>
730          <td class="paramname"> <em>res</em>, </td>
731        </tr>
732        <tr>
733          <td class="paramkey"></td>
734          <td></td>
735          <td class="paramtype">const krb5_address *&nbsp;</td>
736          <td class="paramname"> <em>addr</em>, </td>
737        </tr>
738        <tr>
739          <td class="paramkey"></td>
740          <td></td>
741          <td class="paramtype">int16_t&nbsp;</td>
742          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
743        </tr>
744        <tr>
745          <td></td>
746          <td>)</td>
747          <td></td><td></td><td></td>
748        </tr>
749      </table>
750</div>
751<div class="memdoc">
752
753<p>
754Create an address of type KRB5_ADDRESS_ADDRPORT from (addr, port)<p>
755<dl compact><dt><b>Parameters:</b></dt><dd>
756  <table border="0" cellspacing="2" cellpadding="0">
757    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
758    <tr><td valign="top"></td><td valign="top"><em>res</em>&nbsp;</td><td>built address from addr/port </td></tr>
759    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>address to use </td></tr>
760    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>port to use</td></tr>
761  </table>
762</dl>
763<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
764
765</div>
766</div><p>
767<a class="anchor" name="g55bd20d9a185cf7963e2117c1c804c85"></a><!-- doxytag: member="addr_families.c::krb5_max_sockaddr_size" ref="g55bd20d9a185cf7963e2117c1c804c85" args="(void)" -->
768<div class="memitem">
769<div class="memproto">
770      <table class="memname">
771        <tr>
772          <td class="memname">KRB5_LIB_FUNCTION size_t KRB5_LIB_CALL krb5_max_sockaddr_size           </td>
773          <td>(</td>
774          <td class="paramtype">void&nbsp;</td>
775          <td class="paramname">          </td>
776          <td>&nbsp;)&nbsp;</td>
777          <td></td>
778        </tr>
779      </table>
780</div>
781<div class="memdoc">
782
783<p>
784krb5_max_sockaddr_size returns the max size of the .Li struct sockaddr that the Kerberos library will return.<p>
785<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an size_t of the maximum struct sockaddr. </dd></dl>
786
787</div>
788</div><p>
789<a class="anchor" name="gd7bc7e348e6d36c4cf09dcd2ee5a92a3"></a><!-- doxytag: member="addr_families.c::krb5_parse_address" ref="gd7bc7e348e6d36c4cf09dcd2ee5a92a3" args="(krb5_context context, const char *string, krb5_addresses *addresses)" -->
790<div class="memitem">
791<div class="memproto">
792      <table class="memname">
793        <tr>
794          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_parse_address           </td>
795          <td>(</td>
796          <td class="paramtype">krb5_context&nbsp;</td>
797          <td class="paramname"> <em>context</em>, </td>
798        </tr>
799        <tr>
800          <td class="paramkey"></td>
801          <td></td>
802          <td class="paramtype">const char *&nbsp;</td>
803          <td class="paramname"> <em>string</em>, </td>
804        </tr>
805        <tr>
806          <td class="paramkey"></td>
807          <td></td>
808          <td class="paramtype">krb5_addresses *&nbsp;</td>
809          <td class="paramname"> <em>addresses</em></td><td>&nbsp;</td>
810        </tr>
811        <tr>
812          <td></td>
813          <td>)</td>
814          <td></td><td></td><td></td>
815        </tr>
816      </table>
817</div>
818<div class="memdoc">
819
820<p>
821krb5_parse_address returns the resolved hostname in string to the krb5_addresses addresses .<p>
822<dl compact><dt><b>Parameters:</b></dt><dd>
823  <table border="0" cellspacing="2" cellpadding="0">
824    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
825    <tr><td valign="top"></td><td valign="top"><em>string</em>&nbsp;</td><td></td></tr>
826    <tr><td valign="top"></td><td valign="top"><em>addresses</em>&nbsp;</td><td></td></tr>
827  </table>
828</dl>
829<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
830
831</div>
832</div><p>
833<a class="anchor" name="g6e9adff4c8738f92fa2637698c06ccb9"></a><!-- doxytag: member="addr_families.c::krb5_print_address" ref="g6e9adff4c8738f92fa2637698c06ccb9" args="(const krb5_address *addr, char *str, size_t len, size_t *ret_len)" -->
834<div class="memitem">
835<div class="memproto">
836      <table class="memname">
837        <tr>
838          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_print_address           </td>
839          <td>(</td>
840          <td class="paramtype">const krb5_address *&nbsp;</td>
841          <td class="paramname"> <em>addr</em>, </td>
842        </tr>
843        <tr>
844          <td class="paramkey"></td>
845          <td></td>
846          <td class="paramtype">char *&nbsp;</td>
847          <td class="paramname"> <em>str</em>, </td>
848        </tr>
849        <tr>
850          <td class="paramkey"></td>
851          <td></td>
852          <td class="paramtype">size_t&nbsp;</td>
853          <td class="paramname"> <em>len</em>, </td>
854        </tr>
855        <tr>
856          <td class="paramkey"></td>
857          <td></td>
858          <td class="paramtype">size_t *&nbsp;</td>
859          <td class="paramname"> <em>ret_len</em></td><td>&nbsp;</td>
860        </tr>
861        <tr>
862          <td></td>
863          <td>)</td>
864          <td></td><td></td><td></td>
865        </tr>
866      </table>
867</div>
868<div class="memdoc">
869
870<p>
871krb5_print_address prints the address in addr to the string string that have the length len. If ret_len is not NULL, it will be filled with the length of the string if size were unlimited (not including the final NUL) .<p>
872<dl compact><dt><b>Parameters:</b></dt><dd>
873  <table border="0" cellspacing="2" cellpadding="0">
874    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>address to be printed </td></tr>
875    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>pointer string to print the address into </td></tr>
876    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>length that will fit into area pointed to by "str". </td></tr>
877    <tr><td valign="top"></td><td valign="top"><em>ret_len</em>&nbsp;</td><td>return length the str.</td></tr>
878  </table>
879</dl>
880<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
881
882</div>
883</div><p>
884<a class="anchor" name="gec34704845bdaee3c08ebba2fa87d61e"></a><!-- doxytag: member="addr_families.c::krb5_sockaddr2address" ref="gec34704845bdaee3c08ebba2fa87d61e" args="(krb5_context context, const struct sockaddr *sa, krb5_address *addr)" -->
885<div class="memitem">
886<div class="memproto">
887      <table class="memname">
888        <tr>
889          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_sockaddr2address           </td>
890          <td>(</td>
891          <td class="paramtype">krb5_context&nbsp;</td>
892          <td class="paramname"> <em>context</em>, </td>
893        </tr>
894        <tr>
895          <td class="paramkey"></td>
896          <td></td>
897          <td class="paramtype">const struct sockaddr *&nbsp;</td>
898          <td class="paramname"> <em>sa</em>, </td>
899        </tr>
900        <tr>
901          <td class="paramkey"></td>
902          <td></td>
903          <td class="paramtype">krb5_address *&nbsp;</td>
904          <td class="paramname"> <em>addr</em></td><td>&nbsp;</td>
905        </tr>
906        <tr>
907          <td></td>
908          <td>)</td>
909          <td></td><td></td><td></td>
910        </tr>
911      </table>
912</div>
913<div class="memdoc">
914
915<p>
916krb5_sockaddr2address stores a address a "struct sockaddr" sa in the krb5_address addr.<p>
917<dl compact><dt><b>Parameters:</b></dt><dd>
918  <table border="0" cellspacing="2" cellpadding="0">
919    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
920    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>a struct sockaddr to extract the address from </td></tr>
921    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>an Kerberos 5 address to store the address in.</td></tr>
922  </table>
923</dl>
924<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. </dd></dl>
925
926</div>
927</div><p>
928<a class="anchor" name="g76125115a2c040a3f70a4f66eada77aa"></a><!-- doxytag: member="addr_families.c::krb5_sockaddr2port" ref="g76125115a2c040a3f70a4f66eada77aa" args="(krb5_context context, const struct sockaddr *sa, int16_t *port)" -->
929<div class="memitem">
930<div class="memproto">
931      <table class="memname">
932        <tr>
933          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_sockaddr2port           </td>
934          <td>(</td>
935          <td class="paramtype">krb5_context&nbsp;</td>
936          <td class="paramname"> <em>context</em>, </td>
937        </tr>
938        <tr>
939          <td class="paramkey"></td>
940          <td></td>
941          <td class="paramtype">const struct sockaddr *&nbsp;</td>
942          <td class="paramname"> <em>sa</em>, </td>
943        </tr>
944        <tr>
945          <td class="paramkey"></td>
946          <td></td>
947          <td class="paramtype">int16_t *&nbsp;</td>
948          <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
949        </tr>
950        <tr>
951          <td></td>
952          <td>)</td>
953          <td></td><td></td><td></td>
954        </tr>
955      </table>
956</div>
957<div class="memdoc">
958
959<p>
960krb5_sockaddr2port extracts a port (if possible) from a "struct sockaddr.<p>
961<dl compact><dt><b>Parameters:</b></dt><dd>
962  <table border="0" cellspacing="2" cellpadding="0">
963    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a Keberos context </td></tr>
964    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>a struct sockaddr to extract the port from </td></tr>
965    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>a pointer to an int16_t store the port in.</td></tr>
966  </table>
967</dl>
968<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return an error code or 0. Will return KRB5_PROG_ATYPE_NOSUPP in case address type is not supported. </dd></dl>
969
970</div>
971</div><p>
972<a class="anchor" name="gc4c55c7ef3d078993b0177649593088c"></a><!-- doxytag: member="addr_families.c::krb5_sockaddr_uninteresting" ref="gc4c55c7ef3d078993b0177649593088c" args="(const struct sockaddr *sa)" -->
973<div class="memitem">
974<div class="memproto">
975      <table class="memname">
976        <tr>
977          <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_sockaddr_uninteresting           </td>
978          <td>(</td>
979          <td class="paramtype">const struct sockaddr *&nbsp;</td>
980          <td class="paramname"> <em>sa</em>          </td>
981          <td>&nbsp;)&nbsp;</td>
982          <td></td>
983        </tr>
984      </table>
985</div>
986<div class="memdoc">
987
988<p>
989krb5_sockaddr_uninteresting returns TRUE for all .Fa sa that the kerberos library thinks are uninteresting. One example are link local addresses.<p>
990<dl compact><dt><b>Parameters:</b></dt><dd>
991  <table border="0" cellspacing="2" cellpadding="0">
992    <tr><td valign="top"></td><td valign="top"><em>sa</em>&nbsp;</td><td>pointer to struct sockaddr that might be interesting.</td></tr>
993  </table>
994</dl>
995<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return a non zero for uninteresting addresses. </dd></dl>
996
997</div>
998</div><p>
999</div>
1000<hr size="1"><address style="text-align: right;"><small>
1001Generated on Wed Jan 11 14:07:47 2012 for HeimdalKerberos5library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
1002</body>
1003</html>
1004