1 /* $NetBSD: ip6opt.c,v 1.14 2012/03/20 17:44:18 matt Exp $ */
4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/cdefs.h>
33 #if defined(LIBC_SCCS) && !defined(lint)
34 __RCSID("$NetBSD: ip6opt.c,v 1.14 2012/03/20 17:44:18 matt Exp $");
35 #endif /* LIBC_SCCS and not lint */
37 #include "namespace.h"
38 #include <sys/param.h>
39 #include <sys/types.h>
40 #include <sys/socket.h>
42 #include <netinet/in.h>
43 #include <netinet/ip6.h>
51 __weak_alias(inet6_option_alloc
,_inet6_option_alloc
)
52 __weak_alias(inet6_option_append
,_inet6_option_append
)
53 __weak_alias(inet6_option_find
,_inet6_option_find
)
54 __weak_alias(inet6_option_init
,_inet6_option_init
)
55 __weak_alias(inet6_option_next
,_inet6_option_next
)
56 __weak_alias(inet6_option_space
,_inet6_option_space
)
57 __weak_alias(inet6_opt_init
, _inet6_opt_init
)
58 __weak_alias(inet6_opt_append
, _inet6_opt_append
)
59 __weak_alias(inet6_opt_finish
, _inet6_opt_finish
)
60 __weak_alias(inet6_opt_set_val
, _inet6_opt_set_val
)
61 __weak_alias(inet6_opt_next
, _inet6_opt_next
)
62 __weak_alias(inet6_opt_find
, _inet6_opt_find
)
63 __weak_alias(inet6_opt_get_val
, _inet6_opt_get_val
)
66 static int ip6optlen(uint8_t *opt
, uint8_t *lim
);
67 static void inet6_insert_padopt(uint8_t *p
, size_t len
);
70 * This function returns the number of bytes required to hold an option
71 * when it is stored as ancillary data, including the cmsghdr structure
72 * at the beginning, and any padding at the end (to make its size a
73 * multiple of 8 bytes). The argument is the size of the structure
74 * defining the option, which must include any pad bytes at the
75 * beginning (the value y in the alignment term "xn + y"), the type
76 * byte, the length byte, and the option data.
79 inet6_option_space(int nbytes
)
82 nbytes
+= 2; /* we need space for nxt-hdr and length fields */
83 sp
= CMSG_SPACE((nbytes
+ 7) & ~7);
84 _DIAGASSERT(__type_fit(int, sp
));
89 * This function is called once per ancillary data object that will
90 * contain either Hop-by-Hop or Destination options. It returns 0 on
91 * success or -1 on an error.
94 inet6_option_init(void *bp
, struct cmsghdr
**cmsgp
, int type
)
96 register struct cmsghdr
*ch
;
98 _DIAGASSERT(bp
!= NULL
);
99 _DIAGASSERT(cmsgp
!= NULL
);
101 ch
= (struct cmsghdr
*)bp
;
103 /* argument validation */
104 if (type
!= IPV6_HOPOPTS
&& type
!= IPV6_DSTOPTS
)
107 ch
->cmsg_level
= IPPROTO_IPV6
;
108 ch
->cmsg_type
= type
;
109 ch
->cmsg_len
= CMSG_LEN(0);
116 * This function appends a Hop-by-Hop option or a Destination option
117 * into an ancillary data object that has been initialized by
118 * inet6_option_init(). This function returns 0 if it succeeds or -1 on
120 * multx is the value x in the alignment term "xn + y" described
121 * earlier. It must have a value of 1, 2, 4, or 8.
122 * plusy is the value y in the alignment term "xn + y" described
123 * earlier. It must have a value between 0 and 7, inclusive.
126 inet6_option_append(struct cmsghdr
*cmsg
, const uint8_t *typep
, int multx
,
129 size_t padlen
, optlen
, off
;
130 register uint8_t *bp
;
133 _DIAGASSERT(cmsg
!= NULL
);
134 _DIAGASSERT(typep
!= NULL
);
136 bp
= (uint8_t *)(void *)cmsg
+ cmsg
->cmsg_len
;
137 eh
= (struct ip6_ext
*)(void *)CMSG_DATA(cmsg
);
139 /* argument validation */
140 if (multx
!= 1 && multx
!= 2 && multx
!= 4 && multx
!= 8)
142 if (plusy
< 0 || plusy
> 7)
146 * If this is the first option, allocate space for the
147 * first 2 bytes(for next header and length fields) of
150 if (bp
== (uint8_t *)(void *)eh
) {
155 /* calculate pad length before the option. */
156 off
= bp
- (uint8_t *)(void *)eh
;
157 padlen
= (((off
% multx
) + (multx
- 1)) & ~(multx
- 1)) -
160 padlen
%= multx
; /* keep the pad as short as possible */
162 inet6_insert_padopt(bp
, padlen
);
163 _DIAGASSERT(__type_fit(socklen_t
, padlen
+ cmsg
->cmsg_len
));
164 cmsg
->cmsg_len
+= (socklen_t
)padlen
;
167 /* copy the option */
168 if (typep
[0] == IP6OPT_PAD1
)
171 optlen
= typep
[1] + 2;
172 memcpy(bp
, typep
, (size_t)optlen
);
174 _DIAGASSERT(__type_fit(socklen_t
, optlen
+ cmsg
->cmsg_len
));
175 cmsg
->cmsg_len
+= (socklen_t
)optlen
;
177 /* calculate pad length after the option and insert the padding */
178 off
= bp
- (uint8_t *)(void *)eh
;
179 padlen
= ((off
+ 7) & ~7) - off
;
180 inet6_insert_padopt(bp
, padlen
);
182 _DIAGASSERT(__type_fit(socklen_t
, padlen
+ cmsg
->cmsg_len
));
183 cmsg
->cmsg_len
+= (socklen_t
)padlen
;
185 /* update the length field of the ip6 option header */
186 off
= bp
- (uint8_t *)(void *)eh
;
187 _DIAGASSERT(__type_fit(uint8_t, (off
>> 3) - 1));
188 eh
->ip6e_len
= (uint8_t)((off
>> 3) - 1);
194 * This function appends a Hop-by-Hop option or a Destination option
195 * into an ancillary data object that has been initialized by
196 * inet6_option_init(). This function returns a pointer to the 8-bit
197 * option type field that starts the option on success, or NULL on an
199 * The difference between this function and inet6_option_append() is
200 * that the latter copies the contents of a previously built option into
201 * the ancillary data object while the current function returns a
202 * pointer to the space in the data object where the option's TLV must
203 * then be built by the caller.
207 inet6_option_alloc(struct cmsghdr
*cmsg
, int datalen
, int multx
, int plusy
)
210 register uint8_t *bp
;
214 _DIAGASSERT(cmsg
!= NULL
);
216 bp
= (uint8_t *)(void *)cmsg
+ cmsg
->cmsg_len
;
217 eh
= (struct ip6_ext
*)(void *)CMSG_DATA(cmsg
);
219 /* argument validation */
220 if (multx
!= 1 && multx
!= 2 && multx
!= 4 && multx
!= 8)
222 if (plusy
< 0 || plusy
> 7)
226 * If this is the first option, allocate space for the
227 * first 2 bytes(for next header and length fields) of
230 if (bp
== (uint8_t *)(void *)eh
) {
235 /* calculate pad length before the option. */
236 off
= bp
- (uint8_t *)(void *)eh
;
237 padlen
= (((off
% multx
) + (multx
- 1)) & ~(multx
- 1)) -
240 padlen
%= multx
; /* keep the pad as short as possible */
242 inet6_insert_padopt(bp
, padlen
);
243 cmsg
->cmsg_len
+= (socklen_t
)padlen
;
246 /* keep space to store specified length of data */
249 cmsg
->cmsg_len
+= datalen
;
251 /* calculate pad length after the option and insert the padding */
252 off
= bp
- (uint8_t *)(void *)eh
;
253 padlen
= ((off
+ 7) & ~7) - off
;
254 inet6_insert_padopt(bp
, padlen
);
256 _DIAGASSERT(__type_fit(socklen_t
, padlen
+ cmsg
->cmsg_len
));
257 cmsg
->cmsg_len
+= (socklen_t
)padlen
;
259 /* update the length field of the ip6 option header */
260 off
= bp
- (uint8_t *)(void *)eh
;
261 _DIAGASSERT(__type_fit(uint8_t, (off
>> 3) - 1));
262 eh
->ip6e_len
= (uint8_t)((off
>> 3) - 1);
268 * This function processes the next Hop-by-Hop option or Destination
269 * option in an ancillary data object. If another option remains to be
270 * processed, the return value of the function is 0 and *tptrp points to
271 * the 8-bit option type field (which is followed by the 8-bit option
272 * data length, followed by the option data). If no more options remain
273 * to be processed, the return value is -1 and *tptrp is NULL. If an
274 * error occurs, the return value is -1 and *tptrp is not NULL.
278 inet6_option_next(const struct cmsghdr
*cmsg
, uint8_t **tptrp
)
280 struct ip6_ext
*ip6e
;
284 _DIAGASSERT(cmsg
!= NULL
);
285 _DIAGASSERT(tptrp
!= NULL
);
287 if (cmsg
->cmsg_level
!= IPPROTO_IPV6
||
288 (cmsg
->cmsg_type
!= IPV6_HOPOPTS
&&
289 cmsg
->cmsg_type
!= IPV6_DSTOPTS
))
292 /* message length validation */
293 if (cmsg
->cmsg_len
< CMSG_SPACE(sizeof(struct ip6_ext
)))
295 ip6e
= __UNCONST(CCMSG_DATA(cmsg
));
296 hdrlen
= (ip6e
->ip6e_len
+ 1) << 3;
297 if (cmsg
->cmsg_len
< CMSG_SPACE(hdrlen
))
301 * If the caller does not specify the starting point,
302 * simply return the 1st option.
303 * Otherwise, search the option list for the next option.
305 lim
= (uint8_t *)(void *)ip6e
+ hdrlen
;
307 *tptrp
= (uint8_t *)(void *)(ip6e
+ 1);
309 if ((optlen
= ip6optlen(*tptrp
, lim
)) == 0)
312 *tptrp
= *tptrp
+ optlen
;
314 if (*tptrp
>= lim
) { /* there is no option */
319 * Finally, checks if the next option is safely stored in the
322 if (ip6optlen(*tptrp
, lim
) == 0)
329 * This function is similar to the inet6_option_next() function,
330 * except this function lets the caller specify the option type to be
331 * searched for, instead of always returning the next option in the
332 * ancillary data object.
333 * Note: RFC 2292 says the type of tptrp is uint8_t *, but we think
334 * it's a typo. The variable should be type of uint8_t **.
337 inet6_option_find(const struct cmsghdr
*cmsg
, uint8_t **tptrp
, int type
)
339 struct ip6_ext
*ip6e
;
343 _DIAGASSERT(cmsg
!= NULL
);
344 _DIAGASSERT(tptrp
!= NULL
);
346 if (cmsg
->cmsg_level
!= IPPROTO_IPV6
||
347 (cmsg
->cmsg_type
!= IPV6_HOPOPTS
&&
348 cmsg
->cmsg_type
!= IPV6_DSTOPTS
))
351 /* message length validation */
352 if (cmsg
->cmsg_len
< CMSG_SPACE(sizeof(struct ip6_ext
)))
354 ip6e
= __UNCONST(CCMSG_DATA(cmsg
));
355 hdrlen
= (ip6e
->ip6e_len
+ 1) << 3;
356 if (cmsg
->cmsg_len
< CMSG_SPACE(hdrlen
))
360 * If the caller does not specify the starting point,
361 * search from the beginning of the option list.
362 * Otherwise, search from *the next option* of the specified point.
364 lim
= (uint8_t *)(void *)ip6e
+ hdrlen
;
366 *tptrp
= (uint8_t *)(void *)(ip6e
+ 1);
368 if ((optlen
= ip6optlen(*tptrp
, lim
)) == 0)
371 *tptrp
= *tptrp
+ optlen
;
373 for (optp
= *tptrp
; optp
< lim
; optp
+= optlen
) {
378 if ((optlen
= ip6optlen(optp
, lim
)) == 0)
388 * Calculate the length of a given IPv6 option. Also checks
389 * if the option is safely stored in user's buffer according to the
390 * calculated length and the limitation of the buffer.
393 ip6optlen(uint8_t *opt
, uint8_t *lim
)
397 _DIAGASSERT(opt
!= NULL
);
398 _DIAGASSERT(lim
!= NULL
);
400 if (*opt
== IP6OPT_PAD1
)
403 /* is there enough space to store type and len? */
406 optlen
= *(opt
+ 1) + 2;
408 if (opt
+ optlen
<= lim
)
415 inet6_insert_padopt(uint8_t *p
, size_t len
)
418 _DIAGASSERT(p
!= NULL
);
428 _DIAGASSERT(__type_fit(uint8_t, len
- 2));
429 p
[1] = (uint8_t)(len
- 2);
430 memset(&p
[2], 0, len
- 2);
436 * The following functions are defined in RFC3542, which is a successor
441 inet6_opt_init(void *extbuf
, socklen_t extlen
)
443 struct ip6_ext
*ext
= (struct ip6_ext
*)extbuf
;
451 ext
->ip6e_len
= (extlen
>> 3) - 1;
454 return (2); /* sizeof the next and the length fields */
458 inet6_opt_append(void *extbuf
, socklen_t extlen
, int offset
, uint8_t type
,
459 socklen_t len
, uint8_t align
, void **databufp
)
461 int currentlen
= offset
;
465 * The option type must have a value from 2 to 255, inclusive.
466 * (0 and 1 are reserved for the Pad1 and PadN options, respectively.)
472 * The option data length must have a value between 0 and 255,
473 * inclusive, and is the length of the option data that follows.
479 * The align parameter must have a value of 1, 2, 4, or 8.
480 * The align value can not exceed the value of len.
482 if (align
!= 1 && align
!= 2 && align
!= 4 && align
!= 8)
487 /* Calculate the padding length. */
488 currentlen
+= 2 + len
; /* 2 means "type + len" */
489 if (currentlen
% align
)
490 padlen
= align
- (currentlen
% align
);
492 /* The option must fit in the extension header buffer. */
493 _DIAGASSERT(__type_fit(int, currentlen
+ padlen
));
494 currentlen
+= (int)padlen
;
495 if (extlen
&& /* XXX: right? */
496 (socklen_t
)currentlen
> extlen
)
500 uint8_t *optp
= (uint8_t *)extbuf
+ offset
;
503 /* insert a Pad1 option */
506 } else if (padlen
> 0) {
507 /* insert a PadN option for alignment */
508 *optp
++ = IP6OPT_PADN
;
509 _DIAGASSERT(__type_fit(uint8_t, padlen
- 2));
510 *optp
++ = (uint8_t)(padlen
- 2);
511 memset(optp
, 0, padlen
- 2);
512 optp
+= (padlen
- 2);
525 inet6_opt_finish(void *extbuf
, socklen_t extlen
, int offset
)
527 int updatelen
= offset
> 0 ? (1 + ((offset
- 1) | 7)) : 0;
531 size_t padlen
= updatelen
- offset
;
533 if ((socklen_t
)updatelen
> extlen
|| padlen
>= 256 + 2)
536 padp
= (uint8_t *)extbuf
+ offset
;
539 else if (padlen
> 0) {
540 *padp
++ = IP6OPT_PADN
;
541 *padp
++ = (uint8_t)(padlen
- 2);
542 memset(padp
, 0, padlen
- 2);
550 inet6_opt_set_val(void *databuf
, int offset
, void *val
, socklen_t vallen
)
553 memcpy((uint8_t *)databuf
+ offset
, val
, vallen
);
554 return (offset
+ vallen
);
558 inet6_opt_next(void *extbuf
, socklen_t extlen
, int offset
, uint8_t *typep
,
559 socklen_t
*lenp
, void **databufp
)
564 /* Validate extlen. XXX: is the variable really necessary?? */
565 if (extlen
== 0 || (extlen
% 8))
567 lim
= (uint8_t *)extbuf
+ extlen
;
570 * If this is the first time this function called for this options
571 * header, simply return the 1st option.
572 * Otherwise, search the option list for the next option.
575 optp
= (uint8_t *)(void *)((struct ip6_hbh
*)extbuf
+ 1);
577 optp
= (uint8_t *)extbuf
+ offset
;
579 /* Find the next option skipping any padding options. */
587 if ((optlen
= ip6optlen(optp
, lim
)) == 0)
592 if ((optlen
= ip6optlen(optp
, lim
)) == 0)
596 *databufp
= optp
+ 2;
597 rv
= optp
+ optlen
- (uint8_t *)extbuf
;
598 _DIAGASSERT(__type_fit(int, rv
));
604 *databufp
= NULL
; /* for safety */
609 inet6_opt_find(void *extbuf
, socklen_t extlen
, int offset
, uint8_t type
,
610 socklen_t
*lenp
, void **databufp
)
615 /* Validate extlen. XXX: is the variable really necessary?? */
616 if (extlen
== 0 || (extlen
% 8))
618 lim
= (uint8_t *)extbuf
+ extlen
;
621 * If this is the first time this function called for this options
622 * header, simply return the 1st option.
623 * Otherwise, search the option list for the next option.
626 optp
= (uint8_t *)(void *)((struct ip6_hbh
*)extbuf
+ 1);
628 optp
= (uint8_t *)extbuf
+ offset
;
630 /* Find the specified option */
632 if ((optlen
= ip6optlen(optp
, lim
)) == 0)
635 if (*optp
== type
) { /* found */
638 *databufp
= optp
+ 2;
639 td
= optp
+ optlen
- (uint8_t *)extbuf
;
640 _DIAGASSERT(__type_fit(int, td
));
648 *databufp
= NULL
; /* for safety */
653 inet6_opt_get_val(void *databuf
, int offset
, void *val
, socklen_t vallen
)
656 /* we can't assume alignment here */
657 memcpy(val
, (uint8_t *)databuf
+ offset
, vallen
);
659 return (offset
+ vallen
);