]>
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
17 * along with GNU Zebra; see the file COPYING. If not, write to the Free
18 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
30 #include "sockunion.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 zlog_err("fd %d: can't getsockopt SO_SNDBUF: %d (%s)", sock
,
66 errno
, safe_strerror(errno
));
72 static void *getsockopt_cmsg_data(struct msghdr
*msgh
, int level
, int type
)
77 for (cmsg
= ZCMSG_FIRSTHDR(msgh
); cmsg
!= NULL
;
78 cmsg
= CMSG_NXTHDR(msgh
, cmsg
))
79 if (cmsg
->cmsg_level
== level
&& cmsg
->cmsg_type
)
80 return (ptr
= CMSG_DATA(cmsg
));
85 /* Set IPv6 packet info to the socket. */
86 int setsockopt_ipv6_pktinfo(int sock
, int val
)
90 #ifdef IPV6_RECVPKTINFO /*2292bis-01*/
91 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_RECVPKTINFO
, &val
,
94 zlog_warn("can't setsockopt IPV6_RECVPKTINFO : %s",
95 safe_strerror(errno
));
97 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_PKTINFO
, &val
, sizeof(val
));
99 zlog_warn("can't setsockopt IPV6_PKTINFO : %s",
100 safe_strerror(errno
));
101 #endif /* INIA_IPV6 */
105 /* Set multicast hops val to the socket. */
106 int setsockopt_ipv6_checksum(int sock
, int val
)
111 ret
= setsockopt(sock
, IPPROTO_RAW
, IPV6_CHECKSUM
, &val
, sizeof(val
));
113 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_CHECKSUM
, &val
, sizeof(val
));
114 #endif /* GNU_LINUX */
116 zlog_warn("can't setsockopt IPV6_CHECKSUM");
120 /* Set multicast hops val to the socket. */
121 int setsockopt_ipv6_multicast_hops(int sock
, int val
)
125 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_MULTICAST_HOPS
, &val
,
128 zlog_warn("can't setsockopt IPV6_MULTICAST_HOPS");
132 /* Set multicast hops val to the socket. */
133 int setsockopt_ipv6_unicast_hops(int sock
, int val
)
137 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_UNICAST_HOPS
, &val
,
140 zlog_warn("can't setsockopt IPV6_UNICAST_HOPS");
144 int setsockopt_ipv6_hoplimit(int sock
, int val
)
148 #ifdef IPV6_RECVHOPLIMIT /*2292bis-01*/
149 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_RECVHOPLIMIT
, &val
,
152 zlog_warn("can't setsockopt IPV6_RECVHOPLIMIT");
154 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_HOPLIMIT
, &val
, sizeof(val
));
156 zlog_warn("can't setsockopt IPV6_HOPLIMIT");
161 /* Set multicast loop zero to the socket. */
162 int setsockopt_ipv6_multicast_loop(int sock
, int val
)
166 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_MULTICAST_LOOP
, &val
,
169 zlog_warn("can't setsockopt IPV6_MULTICAST_LOOP");
173 static int getsockopt_ipv6_ifindex(struct msghdr
*msgh
)
175 struct in6_pktinfo
*pktinfo
;
177 pktinfo
= getsockopt_cmsg_data(msgh
, IPPROTO_IPV6
, IPV6_PKTINFO
);
179 return pktinfo
->ipi6_ifindex
;
182 int setsockopt_ipv6_tclass(int sock
, int tclass
)
186 #ifdef IPV6_TCLASS /* RFC3542 */
187 ret
= setsockopt(sock
, IPPROTO_IPV6
, IPV6_TCLASS
, &tclass
,
190 zlog_warn("Can't set IPV6_TCLASS option for fd %d to %#x: %s",
191 sock
, tclass
, safe_strerror(errno
));
197 * Process multicast socket options for IPv4 in an OS-dependent manner.
198 * Supported options are IP_{ADD,DROP}_MEMBERSHIP.
200 * Many operating systems have a limit on the number of groups that
201 * can be joined per socket (where each group and local address
202 * counts). This impacts OSPF, which joins groups on each interface
203 * using a single socket. The limit is typically 20, derived from the
204 * original BSD multicast implementation. Some systems have
205 * mechanisms for increasing this limit.
207 * In many 4.4BSD-derived systems, multicast group operations are not
208 * allowed on interfaces that are not UP. Thus, a previous attempt to
209 * leave the group may have failed, leaving it still joined, and we
210 * drop/join quietly to recover. This may not be necessary, but aims to
211 * defend against unknown behavior in that we will still return an error
212 * if the second join fails. It is not clear how other systems
213 * (e.g. Linux, Solaris) behave when leaving groups on down interfaces,
214 * but this behavior should not be harmful if they behave the same way,
215 * allow leaves, or implicitly leave all groups joined to down interfaces.
217 int setsockopt_ipv4_multicast(int sock
, int optname
, struct in_addr if_addr
,
218 unsigned int mcast_addr
, ifindex_t ifindex
)
222 struct sockaddr_in
*si
;
224 memset(&gr
, 0, sizeof(gr
));
225 si
= (struct sockaddr_in
*)&gr
.gr_group
;
226 gr
.gr_interface
= ifindex
;
227 si
->sin_family
= AF_INET
;
228 #ifdef HAVE_STRUCT_SOCKADDR_IN_SIN_LEN
229 si
->sin_len
= sizeof(struct sockaddr_in
);
230 #endif /* HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */
231 si
->sin_addr
.s_addr
= mcast_addr
;
232 ret
= setsockopt(sock
, IPPROTO_IP
,
233 (optname
== IP_ADD_MEMBERSHIP
) ? MCAST_JOIN_GROUP
235 (void *)&gr
, sizeof(gr
));
236 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
237 && (errno
== EADDRINUSE
)) {
238 setsockopt(sock
, IPPROTO_IP
, MCAST_LEAVE_GROUP
, (void *)&gr
,
240 ret
= setsockopt(sock
, IPPROTO_IP
, MCAST_JOIN_GROUP
,
241 (void *)&gr
, sizeof(gr
));
245 #elif defined(HAVE_STRUCT_IP_MREQN_IMR_IFINDEX) && !defined(__FreeBSD__)
246 struct ip_mreqn mreqn
;
249 assert(optname
== IP_ADD_MEMBERSHIP
|| optname
== IP_DROP_MEMBERSHIP
);
250 memset(&mreqn
, 0, sizeof(mreqn
));
252 mreqn
.imr_multiaddr
.s_addr
= mcast_addr
;
253 mreqn
.imr_ifindex
= ifindex
;
255 ret
= setsockopt(sock
, IPPROTO_IP
, optname
, (void *)&mreqn
,
257 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
258 && (errno
== EADDRINUSE
)) {
259 /* see above: handle possible problem when interface comes back
261 char buf
[1][INET_ADDRSTRLEN
];
263 "setsockopt_ipv4_multicast attempting to drop and "
264 "re-add (fd %d, mcast %s, ifindex %u)",
265 sock
, inet_ntop(AF_INET
, &mreqn
.imr_multiaddr
, buf
[0],
268 setsockopt(sock
, IPPROTO_IP
, IP_DROP_MEMBERSHIP
, (void *)&mreqn
,
270 ret
= setsockopt(sock
, IPPROTO_IP
, IP_ADD_MEMBERSHIP
,
271 (void *)&mreqn
, sizeof(mreqn
));
275 /* Example defines for another OS, boilerplate off other code in this
276 function, AND handle optname as per other sections for consistency !! */
277 /* #elif defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
278 /* Add your favourite OS here! */
280 #elif defined(HAVE_BSD_STRUCT_IP_MREQ_HACK) /* #if OS_TYPE */
281 /* standard BSD API */
286 assert(optname
== IP_ADD_MEMBERSHIP
|| optname
== IP_DROP_MEMBERSHIP
);
289 memset(&mreq
, 0, sizeof(mreq
));
290 mreq
.imr_multiaddr
.s_addr
= mcast_addr
;
291 #if !defined __OpenBSD__
292 mreq
.imr_interface
.s_addr
= htonl(ifindex
);
294 mreq
.imr_interface
.s_addr
= if_addr
.s_addr
;
297 ret
= setsockopt(sock
, IPPROTO_IP
, optname
, (void *)&mreq
,
299 if ((ret
< 0) && (optname
== IP_ADD_MEMBERSHIP
)
300 && (errno
== EADDRINUSE
)) {
301 /* see above: handle possible problem when interface comes back
303 char buf
[1][INET_ADDRSTRLEN
];
305 "setsockopt_ipv4_multicast attempting to drop and "
306 "re-add (fd %d, mcast %s, ifindex %u)",
307 sock
, inet_ntop(AF_INET
, &mreq
.imr_multiaddr
, buf
[0],
310 setsockopt(sock
, IPPROTO_IP
, IP_DROP_MEMBERSHIP
, (void *)&mreq
,
312 ret
= setsockopt(sock
, IPPROTO_IP
, IP_ADD_MEMBERSHIP
,
313 (void *)&mreq
, sizeof(mreq
));
318 #error "Unsupported multicast API"
319 #endif /* #if OS_TYPE */
323 * Set IP_MULTICAST_IF socket option in an OS-dependent manner.
325 int setsockopt_ipv4_multicast_if(int sock
, struct in_addr if_addr
,
329 #ifdef HAVE_STRUCT_IP_MREQN_IMR_IFINDEX
330 struct ip_mreqn mreqn
;
331 memset(&mreqn
, 0, sizeof(mreqn
));
333 mreqn
.imr_ifindex
= ifindex
;
334 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&mreqn
,
337 /* Example defines for another OS, boilerplate off other code in this
339 /* #elif defined(BOGON_NIX) && EXAMPLE_VERSION_CODE > -100000 */
340 /* Add your favourite OS here! */
341 #elif defined(HAVE_BSD_STRUCT_IP_MREQ_HACK)
344 #if !defined __OpenBSD__
345 m
.s_addr
= htonl(ifindex
);
347 m
.s_addr
= if_addr
.s_addr
;
350 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&m
,
352 #elif defined(SUNOS_5)
353 char ifname
[IF_NAMESIZE
];
354 struct ifaddrs
*ifa
, *ifap
;
355 struct in_addr ifaddr
;
357 if (if_indextoname(ifindex
, ifname
) == NULL
)
360 if (getifaddrs(&ifa
) != 0)
363 for (ifap
= ifa
; ifap
!= NULL
; ifap
= ifap
->ifa_next
) {
364 struct sockaddr_in
*sa
;
366 if (strcmp(ifap
->ifa_name
, ifname
) != 0)
368 if (ifap
->ifa_addr
->sa_family
!= AF_INET
)
370 sa
= (struct sockaddr_in
*)ifap
->ifa_addr
;
371 memcpy(&ifaddr
, &sa
->sin_addr
, sizeof(ifaddr
));
376 if (!ifap
) /* This means we did not find an IP */
379 return setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_IF
, (void *)&ifaddr
,
382 #error "Unsupported multicast API"
386 int setsockopt_ipv4_multicast_loop(int sock
, u_char val
)
390 ret
= setsockopt(sock
, IPPROTO_IP
, IP_MULTICAST_LOOP
, (void *)&val
,
393 zlog_warn("can't setsockopt IP_MULTICAST_LOOP");
398 static int setsockopt_ipv4_ifindex(int sock
, ifindex_t val
)
402 #if defined(IP_PKTINFO)
403 if ((ret
= setsockopt(sock
, IPPROTO_IP
, IP_PKTINFO
, &val
, sizeof(val
)))
405 zlog_warn("Can't set IP_PKTINFO option for fd %d to %d: %s",
406 sock
, val
, safe_strerror(errno
));
407 #elif defined(IP_RECVIF)
408 if ((ret
= setsockopt(sock
, IPPROTO_IP
, IP_RECVIF
, &val
, sizeof(val
)))
410 zlog_warn("Can't set IP_RECVIF option for fd %d to %d: %s",
411 sock
, val
, safe_strerror(errno
));
413 #warning "Neither IP_PKTINFO nor IP_RECVIF is available."
414 #warning "Will not be able to receive link info."
415 #warning "Things might be seriously broken.."
416 /* XXX Does this ever happen? Should there be a zlog_warn message here?
423 int setsockopt_ipv4_tos(int sock
, int tos
)
427 ret
= setsockopt(sock
, IPPROTO_IP
, IP_TOS
, &tos
, sizeof(tos
));
429 zlog_warn("Can't set IP_TOS option for fd %d to %#x: %s", sock
,
430 tos
, safe_strerror(errno
));
435 int setsockopt_ifindex(int af
, int sock
, ifindex_t val
)
441 ret
= setsockopt_ipv4_ifindex(sock
, val
);
444 ret
= setsockopt_ipv6_pktinfo(sock
, val
);
447 zlog_warn("setsockopt_ifindex: unknown address family %d", af
);
453 * Requires: msgh is not NULL and points to a valid struct msghdr, which
454 * may or may not have control data about the incoming interface.
456 * Returns the interface index (small integer >= 1) if it can be
457 * determined, or else 0.
459 static ifindex_t
getsockopt_ipv4_ifindex(struct msghdr
*msgh
)
461 /* XXX: initialize to zero? (Always overwritten, so just cosmetic.) */
462 ifindex_t ifindex
= -1;
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
,
470 /* XXX Can pktinfo be NULL? Clean up post 0.98. */
471 ifindex
= pktinfo
->ipi_ifindex
;
473 #elif defined(IP_RECVIF)
475 /* retrieval based on IP_RECVIF */
478 /* BSD systems use a sockaddr_dl as the control message payload. */
479 struct sockaddr_dl
*sdl
;
481 /* SUNOS_5 uses an integer with the index. */
482 ifindex_t
*ifindex_p
;
487 sdl
= (struct sockaddr_dl
*)getsockopt_cmsg_data(msgh
, IPPROTO_IP
,
490 ifindex
= sdl
->sdl_index
;
495 * Solaris. On Solaris 8, IP_RECVIF is defined, but the call to
496 * enable it fails with errno=99, and the struct msghdr has
499 ifindex_p
= (uint_t
*)getsockopt_cmsg_data(msgh
, IPPROTO_IP
, IP_RECVIF
);
500 if (ifindex_p
!= NULL
)
501 ifindex
= *ifindex_p
;
508 * Neither IP_PKTINFO nor IP_RECVIF defined - warn at compile time.
509 * XXX Decide if this is a core service, or if daemons have to cope.
510 * Since Solaris 8 and OpenBSD seem not to provide it, it seems that
511 * daemons have to cope.
513 #warning "getsockopt_ipv4_ifindex: Neither IP_PKTINFO nor IP_RECVIF defined."
514 #warning "Some daemons may fail to operate correctly!"
517 #endif /* IP_PKTINFO */
522 /* return ifindex, 0 if none found */
523 ifindex_t
getsockopt_ifindex(int af
, struct msghdr
*msgh
)
527 return (getsockopt_ipv4_ifindex(msgh
));
530 return (getsockopt_ipv6_ifindex(msgh
));
533 zlog_warn("getsockopt_ifindex: unknown address family %d", af
);
538 /* swab iph between order system uses for IP_HDRINCL and host order */
539 void sockopt_iphdrincl_swab_htosys(struct ip
*iph
)
541 /* BSD and derived take iph in network order, except for
544 #ifndef HAVE_IP_HDRINCL_BSD_ORDER
545 iph
->ip_len
= htons(iph
->ip_len
);
546 iph
->ip_off
= htons(iph
->ip_off
);
547 #endif /* HAVE_IP_HDRINCL_BSD_ORDER */
549 iph
->ip_id
= htons(iph
->ip_id
);
552 void sockopt_iphdrincl_swab_systoh(struct ip
*iph
)
554 #ifndef HAVE_IP_HDRINCL_BSD_ORDER
555 iph
->ip_len
= ntohs(iph
->ip_len
);
556 iph
->ip_off
= ntohs(iph
->ip_off
);
557 #endif /* HAVE_IP_HDRINCL_BSD_ORDER */
559 iph
->ip_id
= ntohs(iph
->ip_id
);
562 int sockopt_tcp_rtt(int sock
)
566 socklen_t len
= sizeof(ti
);
568 if (getsockopt(sock
, IPPROTO_TCP
, TCP_INFO
, &ti
, &len
) != 0)
571 return ti
.tcpi_rtt
/ 1000;
577 int sockopt_tcp_signature(int sock
, union sockunion
*su
, const char *password
)
579 #if defined(HAVE_TCP_MD5_LINUX24) && defined(GNU_LINUX)
580 /* Support for the old Linux 2.4 TCP-MD5 patch, taken from Hasso Tepper's
581 * version of the Quagga patch (based on work by Rick Payne, and Bruce
584 #define TCP_MD5_AUTH 13
585 #define TCP_MD5_AUTH_ADD 1
586 #define TCP_MD5_AUTH_DEL 2
587 struct tcp_rfc2385_cmd
{
588 u_int8_t command
; /* Command - Add/Delete */
589 u_int32_t address
; /* IPV4 address associated */
590 u_int8_t keylen
; /* MD5 Key len (do NOT assume 0 terminated
592 void *key
; /* MD5 Key */
594 struct in_addr
*addr
= &su
->sin
.sin_addr
;
596 cmd
.command
= (password
!= NULL
? TCP_MD5_AUTH_ADD
: TCP_MD5_AUTH_DEL
);
597 cmd
.address
= addr
->s_addr
;
598 cmd
.keylen
= (password
!= NULL
? strlen(password
) : 0);
601 return setsockopt(sock
, IPPROTO_TCP
, TCP_MD5_AUTH
, &cmd
, sizeof cmd
);
603 #elif HAVE_DECL_TCP_MD5SIG
607 * XXX Need to do PF_KEY operation here to add/remove an SA entry,
608 * and add/remove an SP entry for this peer's packet flows also.
610 int md5sig
= password
&& *password
? 1 : 0;
612 int keylen
= password
? strlen(password
) : 0;
613 struct tcp_md5sig md5sig
;
614 union sockunion
*su2
, *susock
;
616 /* Figure out whether the socket and the sockunion are the same family..
617 * adding AF_INET to AF_INET6 needs to be v4 mapped, you'd think..
619 if (!(susock
= sockunion_getsockname(sock
)))
622 if (susock
->sa
.sa_family
== su
->sa
.sa_family
)
628 if (su2
->sa
.sa_family
== AF_INET
) {
629 sockunion_free(susock
);
633 /* If this does not work, then all users of this sockopt will
635 * differentiate between IPv4 and IPv6, and keep seperate
639 * Sadly, it doesn't seem to work at present. It's unknown
641 * this is a bug or not.
643 if (su2
->sa
.sa_family
== AF_INET6
644 && su
->sa
.sa_family
== AF_INET
) {
645 su2
->sin6
.sin6_family
= AF_INET6
;
646 /* V4Map the address */
647 memset(&su2
->sin6
.sin6_addr
, 0,
648 sizeof(struct in6_addr
));
649 su2
->sin6
.sin6_addr
.s6_addr32
[2] = htonl(0xffff);
650 memcpy(&su2
->sin6
.sin6_addr
.s6_addr32
[3],
651 &su
->sin
.sin_addr
, 4);
655 memset(&md5sig
, 0, sizeof(md5sig
));
656 memcpy(&md5sig
.tcpm_addr
, su2
, sizeof(*su2
));
657 md5sig
.tcpm_keylen
= keylen
;
659 memcpy(md5sig
.tcpm_key
, password
, keylen
);
660 sockunion_free(susock
);
661 #endif /* GNU_LINUX */
662 if ((ret
= setsockopt(sock
, IPPROTO_TCP
, TCP_MD5SIG
, &md5sig
,
665 /* ENOENT is harmless. It is returned when we clear a password
667 one was not previously set. */
671 zlog_err("sockopt_tcp_signature: setsockopt(%d): %s",
672 sock
, safe_strerror(errno
));
675 #else /* HAVE_TCP_MD5SIG */
677 #endif /* !HAVE_TCP_MD5SIG */