1 /* BGP network related fucntions
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
24 #include "sockunion.h"
38 #include "lib_errors.h"
40 #include "bgpd/bgpd.h"
41 #include "bgpd/bgp_open.h"
42 #include "bgpd/bgp_fsm.h"
43 #include "bgpd/bgp_attr.h"
44 #include "bgpd/bgp_debug.h"
45 #include "bgpd/bgp_errors.h"
46 #include "bgpd/bgp_network.h"
48 extern struct zebra_privs_t bgpd_privs
;
50 static char *bgp_get_bound_name(struct peer
*peer
);
52 /* BGP listening socket. */
56 struct thread
*thread
;
61 * Set MD5 key for the socket, for the given IPv4 peer address.
62 * If the password is NULL or zero-length, the option will be disabled.
64 static int bgp_md5_set_socket(int socket
, union sockunion
*su
,
69 #if HAVE_DECL_TCP_MD5SIG
71 #endif /* HAVE_TCP_MD5SIG */
75 #if HAVE_DECL_TCP_MD5SIG
76 /* Ensure there is no extraneous port information. */
77 memcpy(&su2
, su
, sizeof(union sockunion
));
78 if (su2
.sa
.sa_family
== AF_INET
)
81 su2
.sin6
.sin6_port
= 0;
82 ret
= sockopt_tcp_signature(socket
, &su2
, password
);
84 #endif /* HAVE_TCP_MD5SIG */
87 flog_warn(EC_BGP_NO_TCP_MD5
,
88 "can't set TCP_MD5SIG option on socket %d: %s",
89 socket
, safe_strerror(en
));
94 /* Helper for bgp_connect */
95 static int bgp_md5_set_connect(int socket
, union sockunion
*su
,
100 #if HAVE_DECL_TCP_MD5SIG
101 frr_elevate_privs(&bgpd_privs
) {
102 ret
= bgp_md5_set_socket(socket
, su
, password
);
104 #endif /* HAVE_TCP_MD5SIG */
109 static int bgp_md5_set_password(struct peer
*peer
, const char *password
)
111 struct listnode
*node
;
113 struct bgp_listener
*listener
;
115 frr_elevate_privs(&bgpd_privs
) {
116 /* Set or unset the password on the listen socket(s). Outbound
117 * connections are taken care of in bgp_connect() below.
119 for (ALL_LIST_ELEMENTS_RO(bm
->listen_sockets
, node
, listener
))
120 if (listener
->su
.sa
.sa_family
121 == peer
->su
.sa
.sa_family
) {
122 ret
= bgp_md5_set_socket(listener
->fd
,
123 &peer
->su
, password
);
130 int bgp_md5_set(struct peer
*peer
)
132 /* Set the password from listen socket. */
133 return bgp_md5_set_password(peer
, peer
->password
);
136 int bgp_md5_unset(struct peer
*peer
)
138 /* Unset the password from listen socket. */
139 return bgp_md5_set_password(peer
, NULL
);
142 int bgp_set_socket_ttl(struct peer
*peer
, int bgp_sock
)
144 char buf
[INET_ADDRSTRLEN
];
147 /* In case of peer is EBGP, we should set TTL for this connection. */
148 if (!peer
->gtsm_hops
&& (peer_sort(peer
) == BGP_PEER_EBGP
)) {
149 ret
= sockopt_ttl(peer
->su
.sa
.sa_family
, bgp_sock
, peer
->ttl
);
153 "%s: Can't set TxTTL on peer (rtrid %s) socket, err = %d",
155 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
160 } else if (peer
->gtsm_hops
) {
161 /* On Linux, setting minttl without setting ttl seems to mess
163 outgoing ttl. Therefore setting both.
165 ret
= sockopt_ttl(peer
->su
.sa
.sa_family
, bgp_sock
, MAXTTL
);
169 "%s: Can't set TxTTL on peer (rtrid %s) socket, err = %d",
171 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
176 ret
= sockopt_minttl(peer
->su
.sa
.sa_family
, bgp_sock
,
177 MAXTTL
+ 1 - peer
->gtsm_hops
);
181 "%s: Can't set MinTTL on peer (rtrid %s) socket, err = %d",
183 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
194 * Obtain the BGP instance that the incoming connection should be processed
195 * against. This is important because more than one VRF could be using the
196 * same IP address space. The instance is got by obtaining the device to
197 * which the incoming connection is bound to. This could either be a VRF
198 * or it could be an interface, which in turn determines the VRF.
200 static int bgp_get_instance_for_inc_conn(int sock
, struct bgp
**bgp_inst
)
202 #ifndef SO_BINDTODEVICE
203 /* only Linux has SO_BINDTODEVICE, but we're in Linux-specific code here
204 * anyway since the assumption is that the interface name returned by
205 * getsockopt() is useful in identifying the VRF, particularly with
207 * VRF l3master device. The whole mechanism is specific to Linux, so...
208 * when other platforms add VRF support, this will need handling here as
209 * well. (or, some restructuring) */
210 *bgp_inst
= bgp_get_default();
214 char name
[VRF_NAMSIZ
+ 1];
215 socklen_t name_len
= VRF_NAMSIZ
;
218 struct listnode
*node
, *nnode
;
222 rc
= getsockopt(sock
, SOL_SOCKET
, SO_BINDTODEVICE
, name
, &name_len
);
224 #if defined(HAVE_CUMULUS)
227 "[Error] BGP SO_BINDTODEVICE get failed (%s), sock %d",
228 safe_strerror(errno
), sock
);
234 *bgp_inst
= bgp_get_default();
235 return 0; /* default instance. */
238 /* First try match to instance; if that fails, check for interfaces. */
239 bgp
= bgp_lookup_by_name(name
);
241 if (!bgp
->vrf_id
) // unexpected
247 /* TODO - This will be optimized once interfaces move into the NS */
248 for (ALL_LIST_ELEMENTS(bm
->bgp
, node
, nnode
, bgp
)) {
249 struct interface
*ifp
;
251 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VIEW
)
254 ifp
= if_lookup_by_name(name
, bgp
->vrf_id
);
261 /* We didn't match to either an instance or an interface. */
266 /* Accept bgp connection. */
267 static int bgp_accept(struct thread
*thread
)
272 struct bgp_listener
*listener
= THREAD_ARG(thread
);
275 char buf
[SU_ADDRSTRLEN
];
276 struct bgp
*bgp
= NULL
;
280 /* Register accept thread. */
281 accept_sock
= THREAD_FD(thread
);
282 if (accept_sock
< 0) {
283 flog_err_sys(LIB_ERR_SOCKET
, "accept_sock is nevative value %d",
287 listener
->thread
= NULL
;
289 thread_add_read(bm
->master
, bgp_accept
, listener
, accept_sock
,
292 /* Accept client connection. */
293 bgp_sock
= sockunion_accept(accept_sock
, &su
);
295 flog_err_sys(LIB_ERR_SOCKET
,
296 "[Error] BGP socket accept failed (%s)",
297 safe_strerror(errno
));
300 set_nonblocking(bgp_sock
);
302 /* Obtain BGP instance this connection is meant for.
303 * - if it is a VRF netns sock, then BGP is in listener structure
304 * - otherwise, the bgp instance need to be demultiplexed
308 else if (bgp_get_instance_for_inc_conn(bgp_sock
, &bgp
)) {
309 if (bgp_debug_neighbor_events(NULL
))
311 "[Event] Could not get instance for incoming conn from %s",
312 inet_sutop(&su
, buf
));
317 /* Set socket send buffer size */
318 setsockopt_so_sendbuf(bgp_sock
, BGP_SOCKET_SNDBUF_SIZE
);
320 /* Check remote IP address */
321 peer1
= peer_lookup(bgp
, &su
);
324 peer1
= peer_lookup_dynamic_neighbor(bgp
, &su
);
326 /* Dynamic neighbor has been created, let it proceed */
327 peer1
->fd
= bgp_sock
;
328 bgp_fsm_change_status(peer1
, Active
);
330 peer1
->t_start
); /* created in peer_create() */
332 if (peer_active(peer1
))
333 BGP_EVENT_ADD(peer1
, TCP_connection_open
);
340 if (bgp_debug_neighbor_events(NULL
)) {
342 "[Event] %s connection rejected - not configured"
343 " and not valid for dynamic",
344 inet_sutop(&su
, buf
));
350 if (CHECK_FLAG(peer1
->flags
, PEER_FLAG_SHUTDOWN
)) {
351 if (bgp_debug_neighbor_events(peer1
))
353 "[Event] connection from %s rejected due to admin shutdown",
354 inet_sutop(&su
, buf
));
360 * Do not accept incoming connections in Clearing state. This can result
361 * in incorect state transitions - e.g., the connection goes back to
362 * Established and then the Clearing_Completed event is generated. Also,
363 * block incoming connection in Deleted state.
365 if (peer1
->status
== Clearing
|| peer1
->status
== Deleted
) {
366 if (bgp_debug_neighbor_events(peer1
))
368 "[Event] Closing incoming conn for %s (%p) state %d",
369 peer1
->host
, peer1
, peer1
->status
);
374 /* Check that at least one AF is activated for the peer. */
375 if (!peer_active(peer1
)) {
376 if (bgp_debug_neighbor_events(peer1
))
378 "%s - incoming conn rejected - no AF activated for peer",
384 if (bgp_debug_neighbor_events(peer1
))
385 zlog_debug("[Event] BGP connection from host %s fd %d",
386 inet_sutop(&su
, buf
), bgp_sock
);
388 if (peer1
->doppelganger
) {
389 /* We have an existing connection. Kill the existing one and run
392 if (bgp_debug_neighbor_events(peer1
))
394 "[Event] New active connection from peer %s, Killing"
395 " previous active connection",
397 peer_delete(peer1
->doppelganger
);
400 if (bgp_set_socket_ttl(peer1
, bgp_sock
) < 0)
401 if (bgp_debug_neighbor_events(peer1
))
403 "[Event] Unable to set min/max TTL on peer %s, Continuing",
406 peer
= peer_create(&su
, peer1
->conf_if
, peer1
->bgp
, peer1
->local_as
,
407 peer1
->as
, peer1
->as_type
, 0, 0, NULL
);
409 hash_release(peer
->bgp
->peerhash
, peer
);
410 hash_get(peer
->bgp
->peerhash
, peer
, hash_alloc_intern
);
412 peer_xfer_config(peer
, peer1
);
413 UNSET_FLAG(peer
->flags
, PEER_FLAG_CONFIG_NODE
);
415 peer
->doppelganger
= peer1
;
416 peer1
->doppelganger
= peer
;
418 vrf_bind(peer
->bgp
->vrf_id
, bgp_sock
, bgp_get_bound_name(peer
));
419 bgp_fsm_change_status(peer
, Active
);
420 BGP_TIMER_OFF(peer
->t_start
); /* created in peer_create() */
422 SET_FLAG(peer
->sflags
, PEER_STATUS_ACCEPT_PEER
);
424 /* Make dummy peer until read Open packet. */
425 if (peer1
->status
== Established
426 && CHECK_FLAG(peer1
->sflags
, PEER_STATUS_NSF_MODE
)) {
427 /* If we have an existing established connection with graceful
429 * capability announced with one or more address families, then
431 * existing established connection and move state to connect.
433 peer1
->last_reset
= PEER_DOWN_NSF_CLOSE_SESSION
;
434 SET_FLAG(peer1
->sflags
, PEER_STATUS_NSF_WAIT
);
435 bgp_event_update(peer1
, TCP_connection_closed
);
438 if (peer_active(peer
)) {
439 BGP_EVENT_ADD(peer
, TCP_connection_open
);
445 /* BGP socket bind. */
446 static char *bgp_get_bound_name(struct peer
*peer
)
453 if ((peer
->bgp
->vrf_id
== VRF_DEFAULT
) && !peer
->ifname
457 if (peer
->su
.sa
.sa_family
!= AF_INET
458 && peer
->su
.sa
.sa_family
!= AF_INET6
)
459 return NULL
; // unexpected
461 /* For IPv6 peering, interface (unnumbered or link-local with interface)
462 * takes precedence over VRF. For IPv4 peering, explicit interface or
463 * VRF are the situations to bind.
465 if (peer
->su
.sa
.sa_family
== AF_INET6
)
466 name
= (peer
->conf_if
? peer
->conf_if
467 : (peer
->ifname
? peer
->ifname
470 name
= peer
->ifname
? peer
->ifname
: peer
->bgp
->name
;
475 static int bgp_update_address(struct interface
*ifp
, const union sockunion
*dst
,
476 union sockunion
*addr
)
478 struct prefix
*p
, *sel
, d
;
479 struct connected
*connected
;
480 struct listnode
*node
;
483 sockunion2hostprefix(dst
, &d
);
487 for (ALL_LIST_ELEMENTS_RO(ifp
->connected
, node
, connected
)) {
488 p
= connected
->address
;
489 if (p
->family
!= d
.family
)
491 if (prefix_common_bits(p
, &d
) > common
) {
493 common
= prefix_common_bits(sel
, &d
);
500 prefix2sockunion(sel
, addr
);
504 /* Update source selection. */
505 static int bgp_update_source(struct peer
*peer
)
507 struct interface
*ifp
;
508 union sockunion addr
;
511 sockunion_init(&addr
);
513 /* Source is specified with interface name. */
514 if (peer
->update_if
) {
515 ifp
= if_lookup_by_name(peer
->update_if
, peer
->bgp
->vrf_id
);
519 if (bgp_update_address(ifp
, &peer
->su
, &addr
))
522 ret
= sockunion_bind(peer
->fd
, &addr
, 0, &addr
);
525 /* Source is specified with IP address. */
526 if (peer
->update_source
)
527 ret
= sockunion_bind(peer
->fd
, peer
->update_source
, 0,
528 peer
->update_source
);
533 #define DATAPLANE_MARK 254 /* main table ID */
535 /* BGP try to connect to the peer. */
536 int bgp_connect(struct peer
*peer
)
538 assert(!CHECK_FLAG(peer
->thread_flags
, PEER_THREAD_WRITES_ON
));
539 assert(!CHECK_FLAG(peer
->thread_flags
, PEER_THREAD_READS_ON
));
540 ifindex_t ifindex
= 0;
542 if (peer
->conf_if
&& BGP_PEER_SU_UNSPEC(peer
)) {
543 zlog_debug("Peer address not learnt: Returning from connect");
546 frr_elevate_privs(&bgpd_privs
) {
547 /* Make socket for the peer. */
548 peer
->fd
= vrf_sockunion_socket(&peer
->su
, peer
->bgp
->vrf_id
,
549 bgp_get_bound_name(peer
));
554 set_nonblocking(peer
->fd
);
556 /* Set socket send buffer size */
557 setsockopt_so_sendbuf(peer
->fd
, BGP_SOCKET_SNDBUF_SIZE
);
559 if (bgp_set_socket_ttl(peer
, peer
->fd
) < 0)
562 sockopt_reuseaddr(peer
->fd
);
563 sockopt_reuseport(peer
->fd
);
564 if (sockopt_mark_default(peer
->fd
, DATAPLANE_MARK
, &bgpd_privs
) < 0)
565 flog_warn(EC_BGP_NO_SOCKOPT_MARK
,
566 "Unable to set mark on FD for peer %s, err=%s",
567 peer
->host
, safe_strerror(errno
));
569 #ifdef IPTOS_PREC_INTERNETCONTROL
570 frr_elevate_privs(&bgpd_privs
) {
571 if (sockunion_family(&peer
->su
) == AF_INET
)
572 setsockopt_ipv4_tos(peer
->fd
,
573 IPTOS_PREC_INTERNETCONTROL
);
574 else if (sockunion_family(&peer
->su
) == AF_INET6
)
575 setsockopt_ipv6_tclass(peer
->fd
,
576 IPTOS_PREC_INTERNETCONTROL
);
581 bgp_md5_set_connect(peer
->fd
, &peer
->su
, peer
->password
);
583 /* Update source bind. */
584 if (bgp_update_source(peer
) < 0) {
585 return connect_error
;
588 if (peer
->conf_if
|| peer
->ifname
)
589 ifindex
= ifname2ifindex(peer
->conf_if
? peer
->conf_if
593 if (bgp_debug_neighbor_events(peer
))
594 zlog_debug("%s [Event] Connect start to %s fd %d", peer
->host
,
595 peer
->host
, peer
->fd
);
597 /* Connect to the remote peer. */
598 return sockunion_connect(peer
->fd
, &peer
->su
, htons(peer
->port
),
602 /* After TCP connection is established. Get local address and port. */
603 int bgp_getsockname(struct peer
*peer
)
605 if (peer
->su_local
) {
606 sockunion_free(peer
->su_local
);
607 peer
->su_local
= NULL
;
610 if (peer
->su_remote
) {
611 sockunion_free(peer
->su_remote
);
612 peer
->su_remote
= NULL
;
615 peer
->su_local
= sockunion_getsockname(peer
->fd
);
618 peer
->su_remote
= sockunion_getpeername(peer
->fd
);
619 if (!peer
->su_remote
)
622 if (bgp_nexthop_set(peer
->su_local
, peer
->su_remote
, &peer
->nexthop
,
624 #if defined(HAVE_CUMULUS)
627 "%s: nexthop_set failed, resetting connection - intf %p",
628 peer
->host
, peer
->nexthop
.ifp
);
636 static int bgp_listener(int sock
, struct sockaddr
*sa
, socklen_t salen
,
639 struct bgp_listener
*listener
;
642 sockopt_reuseaddr(sock
);
643 sockopt_reuseport(sock
);
645 frr_elevate_privs(&bgpd_privs
) {
647 #ifdef IPTOS_PREC_INTERNETCONTROL
648 if (sa
->sa_family
== AF_INET
)
649 setsockopt_ipv4_tos(sock
, IPTOS_PREC_INTERNETCONTROL
);
650 else if (sa
->sa_family
== AF_INET6
)
651 setsockopt_ipv6_tclass(sock
,
652 IPTOS_PREC_INTERNETCONTROL
);
655 sockopt_v6only(sa
->sa_family
, sock
);
657 ret
= bind(sock
, sa
, salen
);
662 flog_err_sys(LIB_ERR_SOCKET
, "bind: %s", safe_strerror(en
));
666 ret
= listen(sock
, SOMAXCONN
);
668 flog_err_sys(LIB_ERR_SOCKET
, "listen: %s",
669 safe_strerror(errno
));
673 listener
= XCALLOC(MTYPE_BGP_LISTENER
, sizeof(*listener
));
676 /* this socket needs a change of ns. record bgp back pointer */
677 if (bgp
->vrf_id
!= VRF_DEFAULT
&& vrf_is_mapped_on_netns(
678 vrf_lookup_by_id(bgp
->vrf_id
)))
681 memcpy(&listener
->su
, sa
, salen
);
682 listener
->thread
= NULL
;
683 thread_add_read(bm
->master
, bgp_accept
, listener
, sock
,
685 listnode_add(bm
->listen_sockets
, listener
);
690 /* IPv6 supported version of BGP server socket setup. */
691 int bgp_socket(struct bgp
*bgp
, unsigned short port
, const char *address
)
693 struct addrinfo
*ainfo
;
694 struct addrinfo
*ainfo_save
;
695 static const struct addrinfo req
= {
696 .ai_family
= AF_UNSPEC
,
697 .ai_flags
= AI_PASSIVE
,
698 .ai_socktype
= SOCK_STREAM
,
701 char port_str
[BUFSIZ
];
703 snprintf(port_str
, sizeof(port_str
), "%d", port
);
704 port_str
[sizeof(port_str
) - 1] = '\0';
706 frr_elevate_privs(&bgpd_privs
) {
707 ret
= vrf_getaddrinfo(address
, port_str
, &req
, &ainfo_save
,
711 flog_err_sys(LIB_ERR_SOCKET
, "getaddrinfo: %s",
717 for (ainfo
= ainfo_save
; ainfo
; ainfo
= ainfo
->ai_next
) {
720 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
723 frr_elevate_privs(&bgpd_privs
) {
724 sock
= vrf_socket(ainfo
->ai_family
,
726 ainfo
->ai_protocol
, bgp
->vrf_id
,
728 == BGP_INSTANCE_TYPE_VRF
729 ? bgp
->name
: NULL
));
732 flog_err_sys(LIB_ERR_SOCKET
, "socket: %s",
733 safe_strerror(errno
));
737 /* if we intend to implement ttl-security, this socket needs
739 sockopt_ttl(ainfo
->ai_family
, sock
, MAXTTL
);
741 ret
= bgp_listener(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
,
748 freeaddrinfo(ainfo_save
);
749 if (count
== 0 && bgp
->inst_type
!= BGP_INSTANCE_TYPE_VRF
) {
752 "%s: no usable addresses please check other programs usage of specified port %d",
754 flog_err_sys(LIB_ERR_SOCKET
, "%s: Program cannot continue",
762 /* this function closes vrf socket
763 * this should be called only for vrf socket with netns backend
765 void bgp_close_vrf_socket(struct bgp
*bgp
)
767 struct listnode
*node
, *next
;
768 struct bgp_listener
*listener
;
773 if (bm
->listen_sockets
== NULL
)
776 for (ALL_LIST_ELEMENTS(bm
->listen_sockets
, node
, next
, listener
)) {
777 if (listener
->bgp
== bgp
) {
778 thread_cancel(listener
->thread
);
780 listnode_delete(bm
->listen_sockets
, listener
);
781 XFREE(MTYPE_BGP_LISTENER
, listener
);
786 /* this function closes main socket
790 struct listnode
*node
, *next
;
791 struct bgp_listener
*listener
;
793 if (bm
->listen_sockets
== NULL
)
796 for (ALL_LIST_ELEMENTS(bm
->listen_sockets
, node
, next
, listener
)) {
799 thread_cancel(listener
->thread
);
801 listnode_delete(bm
->listen_sockets
, listener
);
802 XFREE(MTYPE_BGP_LISTENER
, listener
);