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 zlog_warn("can't set TCP_MD5SIG option on socket %d: %s",
88 socket
, safe_strerror(en
));
93 /* Helper for bgp_connect */
94 static int bgp_md5_set_connect(int socket
, union sockunion
*su
,
99 #if HAVE_DECL_TCP_MD5SIG
100 frr_elevate_privs(&bgpd_privs
) {
101 ret
= bgp_md5_set_socket(socket
, su
, password
);
103 #endif /* HAVE_TCP_MD5SIG */
108 static int bgp_md5_set_password(struct peer
*peer
, const char *password
)
110 struct listnode
*node
;
112 struct bgp_listener
*listener
;
114 frr_elevate_privs(&bgpd_privs
) {
115 /* Set or unset the password on the listen socket(s). Outbound
116 * connections are taken care of in bgp_connect() below.
118 for (ALL_LIST_ELEMENTS_RO(bm
->listen_sockets
, node
, listener
))
119 if (listener
->su
.sa
.sa_family
120 == peer
->su
.sa
.sa_family
) {
121 ret
= bgp_md5_set_socket(listener
->fd
,
122 &peer
->su
, password
);
129 int bgp_md5_set(struct peer
*peer
)
131 /* Set the password from listen socket. */
132 return bgp_md5_set_password(peer
, peer
->password
);
135 int bgp_md5_unset(struct peer
*peer
)
137 /* Unset the password from listen socket. */
138 return bgp_md5_set_password(peer
, NULL
);
141 int bgp_set_socket_ttl(struct peer
*peer
, int bgp_sock
)
143 char buf
[INET_ADDRSTRLEN
];
146 /* In case of peer is EBGP, we should set TTL for this connection. */
147 if (!peer
->gtsm_hops
&& (peer_sort(peer
) == BGP_PEER_EBGP
)) {
148 ret
= sockopt_ttl(peer
->su
.sa
.sa_family
, bgp_sock
, peer
->ttl
);
152 "%s: Can't set TxTTL on peer (rtrid %s) socket, err = %d",
154 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
159 } else if (peer
->gtsm_hops
) {
160 /* On Linux, setting minttl without setting ttl seems to mess
162 outgoing ttl. Therefore setting both.
164 ret
= sockopt_ttl(peer
->su
.sa
.sa_family
, bgp_sock
, MAXTTL
);
168 "%s: Can't set TxTTL on peer (rtrid %s) socket, err = %d",
170 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
175 ret
= sockopt_minttl(peer
->su
.sa
.sa_family
, bgp_sock
,
176 MAXTTL
+ 1 - peer
->gtsm_hops
);
180 "%s: Can't set MinTTL on peer (rtrid %s) socket, err = %d",
182 inet_ntop(AF_INET
, &peer
->remote_id
, buf
,
193 * Obtain the BGP instance that the incoming connection should be processed
194 * against. This is important because more than one VRF could be using the
195 * same IP address space. The instance is got by obtaining the device to
196 * which the incoming connection is bound to. This could either be a VRF
197 * or it could be an interface, which in turn determines the VRF.
199 static int bgp_get_instance_for_inc_conn(int sock
, struct bgp
**bgp_inst
)
201 #ifndef SO_BINDTODEVICE
202 /* only Linux has SO_BINDTODEVICE, but we're in Linux-specific code here
203 * anyway since the assumption is that the interface name returned by
204 * getsockopt() is useful in identifying the VRF, particularly with
206 * VRF l3master device. The whole mechanism is specific to Linux, so...
207 * when other platforms add VRF support, this will need handling here as
208 * well. (or, some restructuring) */
209 *bgp_inst
= bgp_get_default();
213 char name
[VRF_NAMSIZ
+ 1];
214 socklen_t name_len
= VRF_NAMSIZ
;
217 struct listnode
*node
, *nnode
;
221 rc
= getsockopt(sock
, SOL_SOCKET
, SO_BINDTODEVICE
, name
, &name_len
);
223 #if defined(HAVE_CUMULUS)
226 "[Error] BGP SO_BINDTODEVICE get failed (%s), sock %d",
227 safe_strerror(errno
), sock
);
233 *bgp_inst
= bgp_get_default();
234 return 0; /* default instance. */
237 /* First try match to instance; if that fails, check for interfaces. */
238 bgp
= bgp_lookup_by_name(name
);
240 if (!bgp
->vrf_id
) // unexpected
246 /* TODO - This will be optimized once interfaces move into the NS */
247 for (ALL_LIST_ELEMENTS(bm
->bgp
, node
, nnode
, bgp
)) {
248 struct interface
*ifp
;
250 if (bgp
->inst_type
== BGP_INSTANCE_TYPE_VIEW
)
253 ifp
= if_lookup_by_name(name
, bgp
->vrf_id
);
260 /* We didn't match to either an instance or an interface. */
265 /* Accept bgp connection. */
266 static int bgp_accept(struct thread
*thread
)
271 struct bgp_listener
*listener
= THREAD_ARG(thread
);
274 char buf
[SU_ADDRSTRLEN
];
275 struct bgp
*bgp
= NULL
;
279 /* Register accept thread. */
280 accept_sock
= THREAD_FD(thread
);
281 if (accept_sock
< 0) {
282 flog_err_sys(LIB_ERR_SOCKET
, "accept_sock is nevative value %d",
286 listener
->thread
= NULL
;
288 thread_add_read(bm
->master
, bgp_accept
, listener
, accept_sock
,
291 /* Accept client connection. */
292 bgp_sock
= sockunion_accept(accept_sock
, &su
);
294 flog_err_sys(LIB_ERR_SOCKET
,
295 "[Error] BGP socket accept failed (%s)",
296 safe_strerror(errno
));
299 set_nonblocking(bgp_sock
);
301 /* Obtain BGP instance this connection is meant for.
302 * - if it is a VRF netns sock, then BGP is in listener structure
303 * - otherwise, the bgp instance need to be demultiplexed
307 else if (bgp_get_instance_for_inc_conn(bgp_sock
, &bgp
)) {
308 if (bgp_debug_neighbor_events(NULL
))
310 "[Event] Could not get instance for incoming conn from %s",
311 inet_sutop(&su
, buf
));
316 /* Set socket send buffer size */
317 setsockopt_so_sendbuf(bgp_sock
, BGP_SOCKET_SNDBUF_SIZE
);
319 /* Check remote IP address */
320 peer1
= peer_lookup(bgp
, &su
);
323 peer1
= peer_lookup_dynamic_neighbor(bgp
, &su
);
325 /* Dynamic neighbor has been created, let it proceed */
326 peer1
->fd
= bgp_sock
;
327 bgp_fsm_change_status(peer1
, Active
);
329 peer1
->t_start
); /* created in peer_create() */
331 if (peer_active(peer1
))
332 BGP_EVENT_ADD(peer1
, TCP_connection_open
);
339 if (bgp_debug_neighbor_events(NULL
)) {
341 "[Event] %s connection rejected - not configured"
342 " and not valid for dynamic",
343 inet_sutop(&su
, buf
));
349 if (CHECK_FLAG(peer1
->flags
, PEER_FLAG_SHUTDOWN
)) {
350 if (bgp_debug_neighbor_events(peer1
))
352 "[Event] connection from %s rejected due to admin shutdown",
353 inet_sutop(&su
, buf
));
359 * Do not accept incoming connections in Clearing state. This can result
360 * in incorect state transitions - e.g., the connection goes back to
361 * Established and then the Clearing_Completed event is generated. Also,
362 * block incoming connection in Deleted state.
364 if (peer1
->status
== Clearing
|| peer1
->status
== Deleted
) {
365 if (bgp_debug_neighbor_events(peer1
))
367 "[Event] Closing incoming conn for %s (%p) state %d",
368 peer1
->host
, peer1
, peer1
->status
);
373 /* Check that at least one AF is activated for the peer. */
374 if (!peer_active(peer1
)) {
375 if (bgp_debug_neighbor_events(peer1
))
377 "%s - incoming conn rejected - no AF activated for peer",
383 if (bgp_debug_neighbor_events(peer1
))
384 zlog_debug("[Event] BGP connection from host %s fd %d",
385 inet_sutop(&su
, buf
), bgp_sock
);
387 if (peer1
->doppelganger
) {
388 /* We have an existing connection. Kill the existing one and run
391 if (bgp_debug_neighbor_events(peer1
))
393 "[Event] New active connection from peer %s, Killing"
394 " previous active connection",
396 peer_delete(peer1
->doppelganger
);
399 if (bgp_set_socket_ttl(peer1
, bgp_sock
) < 0)
400 if (bgp_debug_neighbor_events(peer1
))
402 "[Event] Unable to set min/max TTL on peer %s, Continuing",
405 peer
= peer_create(&su
, peer1
->conf_if
, peer1
->bgp
, peer1
->local_as
,
406 peer1
->as
, peer1
->as_type
, 0, 0, NULL
);
408 hash_release(peer
->bgp
->peerhash
, peer
);
409 hash_get(peer
->bgp
->peerhash
, peer
, hash_alloc_intern
);
411 peer_xfer_config(peer
, peer1
);
412 UNSET_FLAG(peer
->flags
, PEER_FLAG_CONFIG_NODE
);
414 peer
->doppelganger
= peer1
;
415 peer1
->doppelganger
= peer
;
417 vrf_bind(peer
->bgp
->vrf_id
, bgp_sock
, bgp_get_bound_name(peer
));
418 bgp_fsm_change_status(peer
, Active
);
419 BGP_TIMER_OFF(peer
->t_start
); /* created in peer_create() */
421 SET_FLAG(peer
->sflags
, PEER_STATUS_ACCEPT_PEER
);
423 /* Make dummy peer until read Open packet. */
424 if (peer1
->status
== Established
425 && CHECK_FLAG(peer1
->sflags
, PEER_STATUS_NSF_MODE
)) {
426 /* If we have an existing established connection with graceful
428 * capability announced with one or more address families, then
430 * existing established connection and move state to connect.
432 peer1
->last_reset
= PEER_DOWN_NSF_CLOSE_SESSION
;
433 SET_FLAG(peer1
->sflags
, PEER_STATUS_NSF_WAIT
);
434 bgp_event_update(peer1
, TCP_connection_closed
);
437 if (peer_active(peer
)) {
438 BGP_EVENT_ADD(peer
, TCP_connection_open
);
444 /* BGP socket bind. */
445 static char *bgp_get_bound_name(struct peer
*peer
)
452 if ((peer
->bgp
->vrf_id
== VRF_DEFAULT
) && !peer
->ifname
456 if (peer
->su
.sa
.sa_family
!= AF_INET
457 && peer
->su
.sa
.sa_family
!= AF_INET6
)
458 return NULL
; // unexpected
460 /* For IPv6 peering, interface (unnumbered or link-local with interface)
461 * takes precedence over VRF. For IPv4 peering, explicit interface or
462 * VRF are the situations to bind.
464 if (peer
->su
.sa
.sa_family
== AF_INET6
)
465 name
= (peer
->conf_if
? peer
->conf_if
466 : (peer
->ifname
? peer
->ifname
469 name
= peer
->ifname
? peer
->ifname
: peer
->bgp
->name
;
474 static int bgp_update_address(struct interface
*ifp
, const union sockunion
*dst
,
475 union sockunion
*addr
)
477 struct prefix
*p
, *sel
, d
;
478 struct connected
*connected
;
479 struct listnode
*node
;
482 sockunion2hostprefix(dst
, &d
);
486 for (ALL_LIST_ELEMENTS_RO(ifp
->connected
, node
, connected
)) {
487 p
= connected
->address
;
488 if (p
->family
!= d
.family
)
490 if (prefix_common_bits(p
, &d
) > common
) {
492 common
= prefix_common_bits(sel
, &d
);
499 prefix2sockunion(sel
, addr
);
503 /* Update source selection. */
504 static int bgp_update_source(struct peer
*peer
)
506 struct interface
*ifp
;
507 union sockunion addr
;
510 sockunion_init(&addr
);
512 /* Source is specified with interface name. */
513 if (peer
->update_if
) {
514 ifp
= if_lookup_by_name(peer
->update_if
, peer
->bgp
->vrf_id
);
518 if (bgp_update_address(ifp
, &peer
->su
, &addr
))
521 ret
= sockunion_bind(peer
->fd
, &addr
, 0, &addr
);
524 /* Source is specified with IP address. */
525 if (peer
->update_source
)
526 ret
= sockunion_bind(peer
->fd
, peer
->update_source
, 0,
527 peer
->update_source
);
532 #define DATAPLANE_MARK 254 /* main table ID */
534 /* BGP try to connect to the peer. */
535 int bgp_connect(struct peer
*peer
)
537 assert(!CHECK_FLAG(peer
->thread_flags
, PEER_THREAD_WRITES_ON
));
538 assert(!CHECK_FLAG(peer
->thread_flags
, PEER_THREAD_READS_ON
));
539 ifindex_t ifindex
= 0;
541 if (peer
->conf_if
&& BGP_PEER_SU_UNSPEC(peer
)) {
542 zlog_debug("Peer address not learnt: Returning from connect");
545 frr_elevate_privs(&bgpd_privs
) {
546 /* Make socket for the peer. */
547 peer
->fd
= vrf_sockunion_socket(&peer
->su
, peer
->bgp
->vrf_id
,
548 bgp_get_bound_name(peer
));
553 set_nonblocking(peer
->fd
);
555 /* Set socket send buffer size */
556 setsockopt_so_sendbuf(peer
->fd
, BGP_SOCKET_SNDBUF_SIZE
);
558 if (bgp_set_socket_ttl(peer
, peer
->fd
) < 0)
561 sockopt_reuseaddr(peer
->fd
);
562 sockopt_reuseport(peer
->fd
);
563 if (sockopt_mark_default(peer
->fd
, DATAPLANE_MARK
, &bgpd_privs
) < 0)
564 zlog_warn("Unable to set mark on FD for peer %s, err=%s",
565 peer
->host
, safe_strerror(errno
));
567 #ifdef IPTOS_PREC_INTERNETCONTROL
568 frr_elevate_privs(&bgpd_privs
) {
569 if (sockunion_family(&peer
->su
) == AF_INET
)
570 setsockopt_ipv4_tos(peer
->fd
,
571 IPTOS_PREC_INTERNETCONTROL
);
572 else if (sockunion_family(&peer
->su
) == AF_INET6
)
573 setsockopt_ipv6_tclass(peer
->fd
,
574 IPTOS_PREC_INTERNETCONTROL
);
579 bgp_md5_set_connect(peer
->fd
, &peer
->su
, peer
->password
);
581 /* Update source bind. */
582 if (bgp_update_source(peer
) < 0) {
583 return connect_error
;
586 if (peer
->conf_if
|| peer
->ifname
)
587 ifindex
= ifname2ifindex(peer
->conf_if
? peer
->conf_if
591 if (bgp_debug_neighbor_events(peer
))
592 zlog_debug("%s [Event] Connect start to %s fd %d", peer
->host
,
593 peer
->host
, peer
->fd
);
595 /* Connect to the remote peer. */
596 return sockunion_connect(peer
->fd
, &peer
->su
, htons(peer
->port
),
600 /* After TCP connection is established. Get local address and port. */
601 int bgp_getsockname(struct peer
*peer
)
603 if (peer
->su_local
) {
604 sockunion_free(peer
->su_local
);
605 peer
->su_local
= NULL
;
608 if (peer
->su_remote
) {
609 sockunion_free(peer
->su_remote
);
610 peer
->su_remote
= NULL
;
613 peer
->su_local
= sockunion_getsockname(peer
->fd
);
616 peer
->su_remote
= sockunion_getpeername(peer
->fd
);
617 if (!peer
->su_remote
)
620 if (bgp_nexthop_set(peer
->su_local
, peer
->su_remote
, &peer
->nexthop
,
622 #if defined(HAVE_CUMULUS)
625 "%s: nexthop_set failed, resetting connection - intf %p",
626 peer
->host
, peer
->nexthop
.ifp
);
634 static int bgp_listener(int sock
, struct sockaddr
*sa
, socklen_t salen
,
637 struct bgp_listener
*listener
;
640 sockopt_reuseaddr(sock
);
641 sockopt_reuseport(sock
);
643 frr_elevate_privs(&bgpd_privs
) {
645 #ifdef IPTOS_PREC_INTERNETCONTROL
646 if (sa
->sa_family
== AF_INET
)
647 setsockopt_ipv4_tos(sock
, IPTOS_PREC_INTERNETCONTROL
);
648 else if (sa
->sa_family
== AF_INET6
)
649 setsockopt_ipv6_tclass(sock
,
650 IPTOS_PREC_INTERNETCONTROL
);
653 sockopt_v6only(sa
->sa_family
, sock
);
655 ret
= bind(sock
, sa
, salen
);
660 flog_err_sys(LIB_ERR_SOCKET
, "bind: %s", safe_strerror(en
));
664 ret
= listen(sock
, SOMAXCONN
);
666 flog_err_sys(LIB_ERR_SOCKET
, "listen: %s",
667 safe_strerror(errno
));
671 listener
= XCALLOC(MTYPE_BGP_LISTENER
, sizeof(*listener
));
674 /* this socket needs a change of ns. record bgp back pointer */
675 if (bgp
->vrf_id
!= VRF_DEFAULT
&& vrf_is_mapped_on_netns(bgp
->vrf_id
))
678 memcpy(&listener
->su
, sa
, salen
);
679 listener
->thread
= NULL
;
680 thread_add_read(bm
->master
, bgp_accept
, listener
, sock
,
682 listnode_add(bm
->listen_sockets
, listener
);
687 /* IPv6 supported version of BGP server socket setup. */
688 int bgp_socket(struct bgp
*bgp
, unsigned short port
, const char *address
)
690 struct addrinfo
*ainfo
;
691 struct addrinfo
*ainfo_save
;
692 static const struct addrinfo req
= {
693 .ai_family
= AF_UNSPEC
,
694 .ai_flags
= AI_PASSIVE
,
695 .ai_socktype
= SOCK_STREAM
,
698 char port_str
[BUFSIZ
];
700 snprintf(port_str
, sizeof(port_str
), "%d", port
);
701 port_str
[sizeof(port_str
) - 1] = '\0';
703 frr_elevate_privs(&bgpd_privs
) {
704 ret
= vrf_getaddrinfo(address
, port_str
, &req
, &ainfo_save
,
708 flog_err_sys(LIB_ERR_SOCKET
, "getaddrinfo: %s",
714 for (ainfo
= ainfo_save
; ainfo
; ainfo
= ainfo
->ai_next
) {
717 if (ainfo
->ai_family
!= AF_INET
&& ainfo
->ai_family
!= AF_INET6
)
720 frr_elevate_privs(&bgpd_privs
) {
721 sock
= vrf_socket(ainfo
->ai_family
,
723 ainfo
->ai_protocol
, bgp
->vrf_id
,
725 == BGP_INSTANCE_TYPE_VRF
726 ? bgp
->name
: NULL
));
729 flog_err_sys(LIB_ERR_SOCKET
, "socket: %s",
730 safe_strerror(errno
));
734 /* if we intend to implement ttl-security, this socket needs
736 sockopt_ttl(ainfo
->ai_family
, sock
, MAXTTL
);
738 ret
= bgp_listener(sock
, ainfo
->ai_addr
, ainfo
->ai_addrlen
,
745 freeaddrinfo(ainfo_save
);
746 if (count
== 0 && bgp
->inst_type
!= BGP_INSTANCE_TYPE_VRF
) {
749 "%s: no usable addresses please check other programs usage of specified port %d",
751 flog_err_sys(LIB_ERR_SOCKET
, "%s: Program cannot continue",
759 /* this function closes vrf socket
760 * this should be called only for vrf socket with netns backend
762 void bgp_close_vrf_socket(struct bgp
*bgp
)
764 struct listnode
*node
, *next
;
765 struct bgp_listener
*listener
;
770 if (bm
->listen_sockets
== NULL
)
773 for (ALL_LIST_ELEMENTS(bm
->listen_sockets
, node
, next
, listener
)) {
774 if (listener
->bgp
== bgp
) {
775 thread_cancel(listener
->thread
);
777 listnode_delete(bm
->listen_sockets
, listener
);
778 XFREE(MTYPE_BGP_LISTENER
, listener
);
783 /* this function closes main socket
787 struct listnode
*node
, *next
;
788 struct bgp_listener
*listener
;
790 if (bm
->listen_sockets
== NULL
)
793 for (ALL_LIST_ELEMENTS(bm
->listen_sockets
, node
, next
, listener
)) {
796 thread_cancel(listener
->thread
);
798 listnode_delete(bm
->listen_sockets
, listener
);
799 XFREE(MTYPE_BGP_LISTENER
, listener
);