diff options
Diffstat (limited to 'src/lib/libc/net/inet6_opt_init.3')
-rw-r--r-- | src/lib/libc/net/inet6_opt_init.3 | 338 |
1 files changed, 0 insertions, 338 deletions
diff --git a/src/lib/libc/net/inet6_opt_init.3 b/src/lib/libc/net/inet6_opt_init.3 deleted file mode 100644 index 21880a6382..0000000000 --- a/src/lib/libc/net/inet6_opt_init.3 +++ /dev/null | |||
@@ -1,338 +0,0 @@ | |||
1 | .\" $OpenBSD: inet6_opt_init.3,v 1.3 2007/05/31 19:19:30 jmc Exp $ | ||
2 | .\" $KAME: inet6_opt_init.3,v 1.7 2004/12/27 05:08:23 itojun Exp $ | ||
3 | .\" | ||
4 | .\" Copyright (C) 2004 WIDE Project. | ||
5 | .\" All rights reserved. | ||
6 | .\" | ||
7 | .\" Redistribution and use in source and binary forms, with or without | ||
8 | .\" modification, are permitted provided that the following conditions | ||
9 | .\" are met: | ||
10 | .\" 1. Redistributions of source code must retain the above copyright | ||
11 | .\" notice, this list of conditions and the following disclaimer. | ||
12 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer in the | ||
14 | .\" documentation and/or other materials provided with the distribution. | ||
15 | .\" 3. Neither the name of the project nor the names of its contributors | ||
16 | .\" may be used to endorse or promote products derived from this software | ||
17 | .\" without specific prior written permission. | ||
18 | .\" | ||
19 | .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND | ||
20 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
21 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
22 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE | ||
23 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
24 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
25 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
26 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
27 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
28 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
29 | .\" SUCH DAMAGE. | ||
30 | .\" | ||
31 | .Dd $Mdocdate: May 31 2007 $ | ||
32 | .Dt INET6_OPT_INIT 3 | ||
33 | .Os | ||
34 | .\" | ||
35 | .Sh NAME | ||
36 | .Nm inet6_opt_init , | ||
37 | .Nm inet6_opt_append , | ||
38 | .Nm inet6_opt_finish , | ||
39 | .Nm inet6_opt_set_val , | ||
40 | .Nm inet6_opt_next , | ||
41 | .Nm inet6_opt_find , | ||
42 | .Nm inet6_opt_get_val | ||
43 | .Nd IPv6 Hop-by-Hop and Destination Options manipulation | ||
44 | .\" | ||
45 | .Sh SYNOPSIS | ||
46 | .In netinet/in.h | ||
47 | .Ft "int" | ||
48 | .Fn inet6_opt_init "void *extbuf" "socklen_t extlen" | ||
49 | .Ft "int" | ||
50 | .Fn inet6_opt_append "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t type" "socklen_t len" "u_int8_t align" "void **databufp" | ||
51 | .Ft "int" | ||
52 | .Fn inet6_opt_finish "void *extbuf" "socklen_t extlen" "int offset" | ||
53 | .Ft "int" | ||
54 | .Fn inet6_opt_set_val "void *databuf" "int offset" "void *val" "socklen_t vallen" | ||
55 | .Ft "int" | ||
56 | .Fn inet6_opt_next "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t *typep" "socklen_t *lenp" "void **databufp" | ||
57 | .Ft "int" | ||
58 | .Fn inet6_opt_find "void *extbuf" "socklen_t extlen" "int offset" "u_int8_t type" "socklen_t *lenp" "void **databufp" | ||
59 | .Ft "int" | ||
60 | .Fn inet6_opt_get_val "void *databuf" "socklen_t offset" "void *val" "socklen_t vallen" | ||
61 | .\" | ||
62 | .Sh DESCRIPTION | ||
63 | Building and parsing the Hop-by-Hop and Destination options is | ||
64 | complicated. | ||
65 | The advanced sockets API defines a set of functions to | ||
66 | help applications create and manipulate Hop-by-Hop and Destination | ||
67 | options. | ||
68 | .\"This man page describes the functions specified in | ||
69 | .\"IETF Draft RFC 3542 while the | ||
70 | .\".Xr inet6_options_space 3 | ||
71 | .\"man page documents the functions defined in RFC 2292. | ||
72 | .\"It is expected | ||
73 | .\"that this set of functions will supersede those in RFC 2292 but for | ||
74 | .\"the time being both APIs are retained. | ||
75 | These functions use the | ||
76 | formatting rules specified in Appendix B in RFC 2460, i.e. that the | ||
77 | largest field is placed last in the option. | ||
78 | The function prototypes | ||
79 | for these functions are all contained in the header file | ||
80 | .Aq Pa netinet/in.h . | ||
81 | .\" | ||
82 | .Ss inet6_opt_init | ||
83 | The | ||
84 | .Fn inet6_opt_init | ||
85 | function | ||
86 | returns the number of bytes needed for an empty | ||
87 | extension header, one without any options. | ||
88 | If the | ||
89 | .Va extbuf | ||
90 | argument points to a valid section of memory | ||
91 | then the | ||
92 | .Fn inet6_opt_init | ||
93 | function also initializes the extension header's length field. | ||
94 | When attempting to initialize an extension buffer passed in the | ||
95 | .Va extbuf | ||
96 | argument, | ||
97 | .Fa extlen | ||
98 | must be a positive multiple of 8 or else the function fails and | ||
99 | returns \-1 to the caller. | ||
100 | .\" | ||
101 | .Ss inet6_opt_append | ||
102 | The | ||
103 | .Fn inet6_opt_append | ||
104 | function can perform different jobs. | ||
105 | When a valid | ||
106 | .Fa extbuf | ||
107 | argument is supplied it appends an option to the extension buffer and | ||
108 | returns the updated total length as well as a pointer to the newly | ||
109 | created option in | ||
110 | .Fa databufp . | ||
111 | If the value | ||
112 | of | ||
113 | .Fa extbuf | ||
114 | is | ||
115 | .Dv NULL | ||
116 | then the | ||
117 | .Fn inet6_opt_append | ||
118 | function only reports what the total length would | ||
119 | be if the option were actually appended. | ||
120 | The | ||
121 | .Fa len | ||
122 | and | ||
123 | .Fa align | ||
124 | arguments specify the length of the option and the required data | ||
125 | alignment which must be used when appending the option. | ||
126 | The | ||
127 | .Fa offset | ||
128 | argument should be the length returned by the | ||
129 | .Fn inet6_opt_init | ||
130 | function or a previous call to | ||
131 | .Fn inet6_opt_append . | ||
132 | .Pp | ||
133 | The | ||
134 | .Fa type | ||
135 | argument is the 8-bit option type. | ||
136 | .Pp | ||
137 | After | ||
138 | .Fn inet6_opt_append | ||
139 | has been called, the application can use the buffer pointed to by | ||
140 | .Fa databufp | ||
141 | directly, or use | ||
142 | .Fn inet6_opt_set_val | ||
143 | to specify the data to be contained in the option. | ||
144 | .Pp | ||
145 | Option types of | ||
146 | .Li 0 | ||
147 | and | ||
148 | .Li 1 | ||
149 | are reserved for the | ||
150 | .Li Pad1 | ||
151 | and | ||
152 | .Li PadN | ||
153 | options. | ||
154 | All other values from 2 through 255 may be used by applications. | ||
155 | .Pp | ||
156 | The length of the option data is contained in an 8-bit value and so | ||
157 | may contain any value from 0 through 255. | ||
158 | .Pp | ||
159 | The | ||
160 | .Fa align | ||
161 | parameter must have a value of 1, 2, 4, or 8 and cannot exceed the | ||
162 | value of | ||
163 | .Fa len . | ||
164 | The alignment values represent no alignment, 16-bit, 32-bit and 64-bit | ||
165 | alignments respectively. | ||
166 | .\" | ||
167 | .Ss inet6_opt_finish | ||
168 | The | ||
169 | .Fn inet6_opt_finish | ||
170 | calculates the final padding necessary to make the extension header a | ||
171 | multiple of 8 bytes, as required by the IPv6 extension header | ||
172 | specification, and returns the extension header's updated total | ||
173 | length. | ||
174 | The | ||
175 | .Fa offset | ||
176 | argument should be the length returned by | ||
177 | .Fn inet6_opt_init | ||
178 | or | ||
179 | .Fn inet6_opt_append . | ||
180 | When | ||
181 | .Fa extbuf | ||
182 | is not | ||
183 | .Dv NULL | ||
184 | the function also sets up the appropriate padding bytes by inserting a | ||
185 | Pad1 or PadN option of the proper length. | ||
186 | .Pp | ||
187 | If the extension header is too small to contain the proper padding | ||
188 | then an error of \-1 is returned to the caller. | ||
189 | .\" | ||
190 | .Ss inet6_opt_set_val | ||
191 | The | ||
192 | .Fn inet6_opt_set_val | ||
193 | function inserts data items of various sizes into the data portion of | ||
194 | the option. | ||
195 | The | ||
196 | .Fa databuf | ||
197 | argument is a pointer to memory that was returned by the | ||
198 | .Fn inet6_opt_append | ||
199 | call and the | ||
200 | .Fa offset | ||
201 | argument specifies where the option should be placed in the | ||
202 | data buffer. | ||
203 | The | ||
204 | .Fa val | ||
205 | argument points to an area of memory containing the data to be | ||
206 | inserted into the extension header, and the | ||
207 | .Fa vallen | ||
208 | argument indicates how much data to copy. | ||
209 | .Pp | ||
210 | The caller should ensure that each field is aligned on its natural | ||
211 | boundaries as described in Appendix B of RFC 2460. | ||
212 | .Pp | ||
213 | The function returns the offset for the next field which is calculated as | ||
214 | .Fa offset | ||
215 | + | ||
216 | .Fa vallen | ||
217 | and is used when composing options with multiple fields. | ||
218 | .\" | ||
219 | .Ss inet6_opt_next | ||
220 | The | ||
221 | .Fn inet6_opt_next | ||
222 | function parses received extension headers. | ||
223 | The | ||
224 | .Fa extbuf | ||
225 | and | ||
226 | .Fa extlen | ||
227 | arguments specify the location and length of the extension header | ||
228 | being parsed. | ||
229 | The | ||
230 | .Fa offset | ||
231 | argument should either be zero, for the first option, or the length value | ||
232 | returned by a previous call to | ||
233 | .Fn inet6_opt_next | ||
234 | or | ||
235 | .Fn inet6_opt_find . | ||
236 | The return value specifies the position where to continue scanning the | ||
237 | extension buffer. | ||
238 | The option is returned in the arguments | ||
239 | .Fa typep , lenp , | ||
240 | and | ||
241 | .Fa databufp . | ||
242 | .Fa typep , lenp , | ||
243 | and | ||
244 | .Fa databufp | ||
245 | point to the 8-bit option type, the 8-bit option length and the option | ||
246 | data respectively. | ||
247 | This function does not return any PAD1 or PADN options. | ||
248 | When an error occurs or there are no more options the return | ||
249 | value is \-1. | ||
250 | .\" | ||
251 | .Ss inet6_opt_find | ||
252 | The | ||
253 | .Fn inet6_opt_find | ||
254 | function searches the extension buffer for a particular option type, | ||
255 | passed in through the | ||
256 | .Fa type | ||
257 | argument. | ||
258 | If the option is found then the | ||
259 | .Fa lenp | ||
260 | and | ||
261 | .Fa databufp | ||
262 | arguments are updated to point to the option's length and data | ||
263 | respectively. | ||
264 | .Fa extbuf | ||
265 | and | ||
266 | .Fa extlen | ||
267 | must point to a valid extension buffer and give its length. | ||
268 | The | ||
269 | .Fa offset | ||
270 | argument can be used to search from a location anywhere in the | ||
271 | extension header. | ||
272 | .Ss inet6_opt_get_val | ||
273 | The | ||
274 | .Fn inet6_opt_get_val | ||
275 | function extracts data items of various sizes in the data portion of | ||
276 | the option. | ||
277 | The | ||
278 | .Fa databuf | ||
279 | is a pointer returned by the | ||
280 | .Fn inet6_opt_next | ||
281 | or | ||
282 | .Fn inet6_opt_find | ||
283 | functions. | ||
284 | The | ||
285 | .Fa val | ||
286 | argument points to where the data will be extracted. | ||
287 | The | ||
288 | .Fa offset | ||
289 | argument specifies from where in the data portion of the option the | ||
290 | value should be extracted; the first byte of option data is specified | ||
291 | by an offset of zero. | ||
292 | .Pp | ||
293 | It is expected that each field is aligned on its natural boundaries as | ||
294 | described in Appendix B of RFC 2460. | ||
295 | .Pp | ||
296 | The function returns the offset for the next field | ||
297 | by calculating | ||
298 | .Fa offset | ||
299 | + | ||
300 | .Fa vallen | ||
301 | which can be used when extracting option content with multiple fields. | ||
302 | Robust receivers must verify alignment before calling this function. | ||
303 | .\" | ||
304 | .Sh EXAMPLES | ||
305 | RFC 3542 gives comprehensive examples in Section 23. | ||
306 | KAME also provides examples in the | ||
307 | .Pa advapitest | ||
308 | directory of its kit. | ||
309 | .\" | ||
310 | .Sh DIAGNOSTICS | ||
311 | All the functions return | ||
312 | \-1 | ||
313 | on an error. | ||
314 | .\" | ||
315 | .Sh SEE ALSO | ||
316 | .Rs | ||
317 | .%A W. Stevens | ||
318 | .%A M. Thomas | ||
319 | .%A E. Nordmark | ||
320 | .%A T. Jinmei | ||
321 | .%T "Advanced Sockets API for IPv6" | ||
322 | .%N RFC 3542 | ||
323 | .%D October 2002 | ||
324 | .Re | ||
325 | .Rs | ||
326 | .%A S. Deering | ||
327 | .%A R. Hinden | ||
328 | .%T "Internet Protocol, Version 6 (IPv6) Specification" | ||
329 | .%N RFC 2460 | ||
330 | .%D December 1998 | ||
331 | .Re | ||
332 | .Sh STANDARDS | ||
333 | The functions are documented in | ||
334 | .Dq Advanced Sockets API for IPv6 | ||
335 | .Pq RFC 3542 . | ||
336 | .Sh HISTORY | ||
337 | The implementation first appeared in KAME advanced networking kit. | ||
338 | .\" | ||