]>
git.proxmox.com Git - mirror_frr.git/blob - lib/sockopt.c
1 /* setsockopt functions
2 * Copyright (C) 1999 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 #include "sockunion.h"
30 #include "lib_errors.h"
32 void setsockopt_so_recvbuf(int sock
, int size
)
36 while (setsockopt(sock
, SOL_SOCKET
, SO_RCVBUF
, &size
, sizeof(size
))
41 zlog_warn("%s: fd %d: SO_RCVBUF set to %d (requested %d)",
42 __func__
, sock
, size
, orig_req
);
45 void setsockopt_so_sendbuf(const int sock
, int size
)
49 while (setsockopt(sock
, SOL_SOCKET
, SO_SNDBUF
, &size
, sizeof(size
))
54 zlog_warn("%s: fd %d: SO_SNDBUF set to %d (requested %d)",
55 __func__
, sock
, size
, orig_req
);
58 int getsockopt_so_sendbuf(const int sock
)
61 socklen_t optlen
= sizeof(optval
);
62 int ret
= getsockopt(sock
, SOL_SOCKET
, SO_SNDBUF
, (char *)&optval
,
65 flog_err_sys(LIB_ERR_SYSTEM_CALL
,
66 "fd %d: can't getsockopt SO_SNDBUF: %d (%s)", sock
,
67 errno
, safe_strerror(errno
));
73 static void *getsockopt_cmsg_data(struct msghdr
*msgh
, int level
, int type
)
78 for (cmsg
= CMSG_FIRSTHDR(msgh
); cmsg
!= NULL
;
79 cmsg
= CMSG_NXTHDR(msgh
, cmsg
))
80 if (cmsg
->cmsg_level
== level
&& cmsg
->cmsg_type
== type
)
81 return (ptr
= CMSG_DATA(cmsg
));
86 /* Set IPv6 packet info to the socket. */
87 int setsockopt_ipv6_pktinfo(int sock
, int val
)
91 #ifdef IPV6_RECVPKTINFO /*2292bis-01*/
92 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_RECVPKTINFO
, &val
,
95 zlog_warn("can't setsockopt IPV6_RECVPKTINFO : %s",
96 safe_strerror(errno
));
98 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_PKTINFO
, &val
, sizeof(val
));
100 zlog_warn("can't setsockopt IPV6_PKTINFO : %s",
101 safe_strerror(errno
));
102 #endif /* INIA_IPV6 */
106 /* Set multicast hops val to the socket. */
107 int setsockopt_ipv6_checksum(int sock
, int val
)
112 ret
= setsockopt(sock
, IPPROTO_RAW
, IPV6_CHECKSUM
, &val
, sizeof(val
));
114 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_CHECKSUM
, &val
, sizeof(val
));
115 #endif /* GNU_LINUX */
117 zlog_warn("can't setsockopt IPV6_CHECKSUM");
121 /* Set multicast hops val to the socket. */
122 int setsockopt_ipv6_multicast_hops(int sock
, int val
)
126 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_MULTICAST_HOPS
, &val
,
129 zlog_warn("can't setsockopt IPV6_MULTICAST_HOPS");
133 /* Set multicast hops val to the socket. */
134 int setsockopt_ipv6_unicast_hops(int sock
, int val
)
138 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_UNICAST_HOPS
, &val
,
141 zlog_warn("can't setsockopt IPV6_UNICAST_HOPS");
145 int setsockopt_ipv6_hoplimit(int sock
, int val
)
149 #ifdef IPV6_RECVHOPLIMIT /*2292bis-01*/
150 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_RECVHOPLIMIT
, &val
,
153 zlog_warn("can't setsockopt IPV6_RECVHOPLIMIT");
155 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_HOPLIMIT
, &val
, sizeof(val
));
157 zlog_warn("can't setsockopt IPV6_HOPLIMIT");
162 /* Set multicast loop zero to the socket. */
163 int setsockopt_ipv6_multicast_loop(int sock
, int val
)
167 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_MULTICAST_LOOP
, &val
,
170 zlog_warn("can't setsockopt IPV6_MULTICAST_LOOP");
174 static int getsockopt_ipv6_ifindex(struct msghdr
*msgh
)
176 struct in6_pktinfo
*pktinfo
;
178 pktinfo
= getsockopt_cmsg_data(msgh
, IPPROTO_IPV6
, IPV6_PKTINFO
);
180 return pktinfo
->ipi6_ifindex
;
183 int setsockopt_ipv6_tclass(int sock
, int tclass
)
187 #ifdef IPV6_TCLASS /* RFC3542 */
188 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_TCLASS
, &tclass
,
191 zlog_warn("Can't set IPV6_TCLASS option for fd %d to %#x: %s",
192 sock
, tclass
, safe_strerror(errno
));
198 * Process multicast socket options for IPv4 in an OS-dependent manner.
199 * Supported options are IP_{ADD,DROP}_MEMBERSHIP.
201 * Many operating systems have a limit on the number of groups that
202 * can be joined per socket (where each group and local address
203 * counts). This impacts OSPF, which joins groups on each interface
204 * using a single socket. The limit is typically 20, derived from the
205 * original BSD multicast implementation. Some systems have
206 * mechanisms for increasing this limit.
208 * In many 4.4BSD-derived systems, multicast group operations are not
209 * allowed on interfaces that are not UP. Thus, a previous attempt to
210 * leave the group may have failed, leaving it still joined, and we
211 * drop/join quietly to recover. This may not be necessary, but aims to
212 * defend against unknown behavior in that we will still return an error
213 * if the second join fails. It is not clear how other systems
214 * (e.g. Linux, Solaris) behave when leaving groups on down interfaces,
215 * but this behavior should not be harmful if they behave the same way,
216 * allow leaves, or implicitly leave all groups joined to down interfaces.
218 int setsockopt_ipv4_multicast(int sock
, int optname
, struct in_addr if_addr
,
219 unsigned int mcast_addr
, ifindex_t ifindex
)
223 struct sockaddr_in
*si
;
225 memset(&gr
, 0, sizeof(gr
));
226 si
= (struct sockaddr_in
*)&gr
.gr_group
;
227 gr
.gr_interface
= ifindex
;
228 si
->sin_family
= AF_INET
;
229 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
230 si
->sin_len
= sizeof(struct sockaddr_in
);
231 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
232 si
->sin_addr
.s_addr
= mcast_addr
;
233 ret
= setsockopt(sock
, IPPROTO_IP
,
234 (optname
== IP_ADD_MEMBERSHIP
) ? MCAST_JOIN_GROUP
236 (void *)&gr
, sizeof(gr
));
237 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
238 && (errno
== EADDRINUSE
)) {
239 setsockopt(sock
, IPPROTO_IP
, MCAST_LEAVE_GROUP
, (void *)&gr
,
241 ret
= setsockopt(sock
, IPPROTO_IP
, MCAST_JOIN_GROUP
,
242 (void *)&gr
, sizeof(gr
));
246 #elif defined(HAVE_STRUCT_IP_MREQN_IMR_IFINDEX) && !defined(__FreeBSD__)
247 struct ip_mreqn mreqn
;
250 assert(optname
== IP_ADD_MEMBERSHIP
|| optname
== IP_DROP_MEMBERSHIP
);
251 memset(&mreqn
, 0, sizeof(mreqn
));
253 mreqn
.imr_multiaddr
.s_addr
= mcast_addr
;
254 mreqn
.imr_ifindex
= ifindex
;
256 ret
= setsockopt(sock
, IPPROTO_IP
, optname
, (void *)&mreqn
,
258 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
259 && (errno
== EADDRINUSE
)) {
260 /* see above: handle possible problem when interface comes back
262 char buf
[1][INET_ADDRSTRLEN
];
264 "setsockopt_ipv4_multicast attempting to drop and "
265 "re-add (fd %d, mcast %s, ifindex %u)",
266 sock
, inet_ntop(AF_INET
, &mreqn
.imr_multiaddr
, buf
[0],
269 setsockopt(sock
, IPPROTO_IP
, IP_DROP_MEMBERSHIP
, (void *)&mreqn
,
271 ret
= setsockopt(sock
, IPPROTO_IP
, IP_ADD_MEMBERSHIP
,
272 (void *)&mreqn
, sizeof(mreqn
));
276 /* Example defines for another OS, boilerplate off other code in this
277 function, AND handle optname as per other sections for consistency !! */
278 /* #elif defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
279 /* Add your favourite OS here! */
281 #elif defined(HAVE_BSD_STRUCT_IP_MREQ_HACK) /* #if OS_TYPE */
282 /* standard BSD API */
287 assert(optname
== IP_ADD_MEMBERSHIP
|| optname
== IP_DROP_MEMBERSHIP
);
290 memset(&mreq
, 0, sizeof(mreq
));
291 mreq
.imr_multiaddr
.s_addr
= mcast_addr
;
292 #if !defined __OpenBSD__
293 mreq
.imr_interface
.s_addr
= htonl(ifindex
);
295 mreq
.imr_interface
.s_addr
= if_addr
.s_addr
;
298 ret
= setsockopt(sock
, IPPROTO_IP
, optname
, (void *)&mreq
,
300 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
301 && (errno
== EADDRINUSE
)) {
302 /* see above: handle possible problem when interface comes back
304 char buf
[1][INET_ADDRSTRLEN
];
306 "setsockopt_ipv4_multicast attempting to drop and "
307 "re-add (fd %d, mcast %s, ifindex %u)",
308 sock
, inet_ntop(AF_INET
, &mreq
.imr_multiaddr
, buf
[0],
311 setsockopt(sock
, IPPROTO_IP
, IP_DROP_MEMBERSHIP
, (void *)&mreq
,
313 ret
= setsockopt(sock
, IPPROTO_IP
, IP_ADD_MEMBERSHIP
,
314 (void *)&mreq
, sizeof(mreq
));
319 #error "Unsupported multicast API"
320 #endif /* #if OS_TYPE */
324 * Set IP_MULTICAST_IF socket option in an OS-dependent manner.
326 int setsockopt_ipv4_multicast_if(int sock
, struct in_addr if_addr
,
330 #ifdef HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
331 struct ip_mreqn mreqn
;
332 memset(&mreqn
, 0, sizeof(mreqn
));
334 mreqn
.imr_ifindex
= ifindex
;
335 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&mreqn
,
338 /* Example defines for another OS, boilerplate off other code in this
340 /* #elif defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
341 /* Add your favourite OS here! */
342 #elif defined(HAVE_BSD_STRUCT_IP_MREQ_HACK)
345 #if !defined __OpenBSD__
346 m
.s_addr
= htonl(ifindex
);
348 m
.s_addr
= if_addr
.s_addr
;
351 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&m
,
353 #elif defined(SUNOS_5)
354 char ifname
[IF_NAMESIZE
];
355 struct ifaddrs
*ifa
, *ifap
;
356 struct in_addr ifaddr
;
358 if (if_indextoname(ifindex
, ifname
) == NULL
)
361 if (getifaddrs(&ifa
) != 0)
364 for (ifap
= ifa
; ifap
!= NULL
; ifap
= ifap
->ifa_next
) {
365 struct sockaddr_in
*sa
;
367 if (strcmp(ifap
->ifa_name
, ifname
) != 0)
369 if (ifap
->ifa_addr
->sa_family
!= AF_INET
)
371 sa
= (struct sockaddr_in
*)ifap
->ifa_addr
;
372 memcpy(&ifaddr
, &sa
->sin_addr
, sizeof(ifaddr
));
377 if (!ifap
) /* This means we did not find an IP */
380 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&ifaddr
,
383 #error "Unsupported multicast API"
387 int setsockopt_ipv4_multicast_loop(int sock
, uint8_t val
)
391 ret
= setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_LOOP
, (void *)&val
,
394 zlog_warn("can't setsockopt IP_MULTICAST_LOOP");
399 static int setsockopt_ipv4_ifindex(int sock
, ifindex_t val
)
403 #if defined(IP_PKTINFO)
404 if ((ret
= setsockopt(sock
, IPPROTO_IP
, IP_PKTINFO
, &val
, sizeof(val
)))
406 zlog_warn("Can't set IP_PKTINFO option for fd %d to %d: %s",
407 sock
, val
, safe_strerror(errno
));
408 #elif defined(IP_RECVIF)
409 if ((ret
= setsockopt(sock
, IPPROTO_IP
, IP_RECVIF
, &val
, sizeof(val
)))
411 zlog_warn("Can't set IP_RECVIF option for fd %d to %d: %s",
412 sock
, val
, safe_strerror(errno
));
414 #warning "Neither IP_PKTINFO nor IP_RECVIF is available."
415 #warning "Will not be able to receive link info."
416 #warning "Things might be seriously broken.."
417 /* XXX Does this ever happen? Should there be a zlog_warn message here?
424 int setsockopt_ipv4_tos(int sock
, int tos
)
428 ret
= setsockopt(sock
, IPPROTO_IP
, IP_TOS
, &tos
, sizeof(tos
));
430 zlog_warn("Can't set IP_TOS option for fd %d to %#x: %s", sock
,
431 tos
, safe_strerror(errno
));
436 int setsockopt_ifindex(int af
, int sock
, ifindex_t val
)
442 ret
= setsockopt_ipv4_ifindex(sock
, val
);
445 ret
= setsockopt_ipv6_pktinfo(sock
, val
);
448 zlog_warn("setsockopt_ifindex: unknown address family %d", af
);
454 * Requires: msgh is not NULL and points to a valid struct msghdr, which
455 * may or may not have control data about the incoming interface.
457 * Returns the interface index (small integer >= 1) if it can be
458 * determined, or else 0.
460 static ifindex_t
getsockopt_ipv4_ifindex(struct msghdr
*msgh
)
464 #if defined(IP_PKTINFO)
465 /* Linux pktinfo based ifindex retrieval */
466 struct in_pktinfo
*pktinfo
;
468 pktinfo
= (struct in_pktinfo
*)getsockopt_cmsg_data(msgh
, IPPROTO_IP
,
471 /* getsockopt_ifindex() will forward this, being 0 "not found" */
475 ifindex
= pktinfo
->ipi_ifindex
;
477 #elif defined(IP_RECVIF)
479 /* retrieval based on IP_RECVIF */
482 /* BSD systems use a sockaddr_dl as the control message payload. */
483 struct sockaddr_dl
*sdl
;
485 /* SUNOS_5 uses an integer with the index. */
486 ifindex_t
*ifindex_p
;
491 sdl
= (struct sockaddr_dl
*)getsockopt_cmsg_data(msgh
, IPPROTO_IP
,
494 ifindex
= sdl
->sdl_index
;
499 * Solaris. On Solaris 8, IP_RECVIF is defined, but the call to
500 * enable it fails with errno=99, and the struct msghdr has
503 ifindex_p
= (uint_t
*)getsockopt_cmsg_data(msgh
, IPPROTO_IP
, IP_RECVIF
);
504 if (ifindex_p
!= NULL
)
505 ifindex
= *ifindex_p
;
512 * Neither IP_PKTINFO nor IP_RECVIF defined - warn at compile time.
513 * XXX Decide if this is a core service, or if daemons have to cope.
514 * Since Solaris 8 and OpenBSD seem not to provide it, it seems that
515 * daemons have to cope.
517 #warning "getsockopt_ipv4_ifindex: Neither IP_PKTINFO nor IP_RECVIF defined."
518 #warning "Some daemons may fail to operate correctly!"
521 #endif /* IP_PKTINFO */
526 /* return ifindex, 0 if none found */
527 ifindex_t
getsockopt_ifindex(int af
, struct msghdr
*msgh
)
531 return (getsockopt_ipv4_ifindex(msgh
));
534 return (getsockopt_ipv6_ifindex(msgh
));
537 zlog_warn("getsockopt_ifindex: unknown address family %d", af
);
542 /* swab iph between order system uses for IP_HDRINCL and host order */
543 void sockopt_iphdrincl_swab_htosys(struct ip
*iph
)
545 /* BSD and derived take iph in network order, except for
548 #ifndef HAVE_IP_HDRINCL_BSD_ORDER
549 iph
->ip_len
= htons(iph
->ip_len
);
550 iph
->ip_off
= htons(iph
->ip_off
);
551 #endif /* HAVE_IP_HDRINCL_BSD_ORDER */
553 iph
->ip_id
= htons(iph
->ip_id
);
556 void sockopt_iphdrincl_swab_systoh(struct ip
*iph
)
558 #ifndef HAVE_IP_HDRINCL_BSD_ORDER
559 iph
->ip_len
= ntohs(iph
->ip_len
);
560 iph
->ip_off
= ntohs(iph
->ip_off
);
561 #endif /* HAVE_IP_HDRINCL_BSD_ORDER */
563 iph
->ip_id
= ntohs(iph
->ip_id
);
566 int sockopt_tcp_rtt(int sock
)
570 socklen_t len
= sizeof(ti
);
572 if (getsockopt(sock
, IPPROTO_TCP
, TCP_INFO
, &ti
, &len
) != 0)
575 return ti
.tcpi_rtt
/ 1000;
581 int sockopt_tcp_signature(int sock
, union sockunion
*su
, const char *password
)
583 #if defined(HAVE_TCP_MD5_LINUX24) && defined(GNU_LINUX)
584 /* Support for the old Linux 2.4 TCP-MD5 patch, taken from Hasso Tepper's
585 * version of the Quagga patch (based on work by Rick Payne, and Bruce
588 #define TCP_MD5_AUTH 13
589 #define TCP_MD5_AUTH_ADD 1
590 #define TCP_MD5_AUTH_DEL 2
591 struct tcp_rfc2385_cmd
{
592 uint8_t command
; /* Command - Add/Delete */
593 uint32_t address
; /* IPV4 address associated */
594 uint8_t keylen
; /* MD5 Key len (do NOT assume 0 terminated
596 void *key
; /* MD5 Key */
598 struct in_addr
*addr
= &su
->sin
.sin_addr
;
600 cmd
.command
= (password
!= NULL
? TCP_MD5_AUTH_ADD
: TCP_MD5_AUTH_DEL
);
601 cmd
.address
= addr
->s_addr
;
602 cmd
.keylen
= (password
!= NULL
? strlen(password
) : 0);
605 return setsockopt(sock
, IPPROTO_TCP
, TCP_MD5_AUTH
, &cmd
, sizeof cmd
);
607 #elif HAVE_DECL_TCP_MD5SIG
611 * XXX Need to do PF_KEY operation here to add/remove an SA entry,
612 * and add/remove an SP entry for this peer's packet flows also.
614 int md5sig
= password
&& *password
? 1 : 0;
616 int keylen
= password
? strlen(password
) : 0;
617 struct tcp_md5sig md5sig
;
618 union sockunion
*su2
, *susock
;
620 /* Figure out whether the socket and the sockunion are the same family..
621 * adding AF_INET to AF_INET6 needs to be v4 mapped, you'd think..
623 if (!(susock
= sockunion_getsockname(sock
)))
626 if (susock
->sa
.sa_family
== su
->sa
.sa_family
)
632 if (su2
->sa
.sa_family
== AF_INET
) {
633 sockunion_free(susock
);
637 /* If this does not work, then all users of this sockopt will
639 * differentiate between IPv4 and IPv6, and keep seperate
643 * Sadly, it doesn't seem to work at present. It's unknown
645 * this is a bug or not.
647 if (su2
->sa
.sa_family
== AF_INET6
648 && su
->sa
.sa_family
== AF_INET
) {
649 su2
->sin6
.sin6_family
= AF_INET6
;
650 /* V4Map the address */
651 memset(&su2
->sin6
.sin6_addr
, 0,
652 sizeof(struct in6_addr
));
653 su2
->sin6
.sin6_addr
.s6_addr32
[2] = htonl(0xffff);
654 memcpy(&su2
->sin6
.sin6_addr
.s6_addr32
[3],
655 &su
->sin
.sin_addr
, 4);
659 memset(&md5sig
, 0, sizeof(md5sig
));
660 memcpy(&md5sig
.tcpm_addr
, su2
, sizeof(*su2
));
661 md5sig
.tcpm_keylen
= keylen
;
663 memcpy(md5sig
.tcpm_key
, password
, keylen
);
664 sockunion_free(susock
);
665 #endif /* GNU_LINUX */
666 if ((ret
= setsockopt(sock
, IPPROTO_TCP
, TCP_MD5SIG
, &md5sig
,
669 /* ENOENT is harmless. It is returned when we clear a password
671 one was not previously set. */
677 "sockopt_tcp_signature: setsockopt(%d): %s",
678 sock
, safe_strerror(errno
));
681 #else /* HAVE_TCP_MD5SIG */
683 #endif /* !HAVE_TCP_MD5SIG */