2 * EIGRP Sending and Receiving EIGRP Hello Packets.
3 * Copyright (C) 2013-2016
15 * This file is part of GNU Zebra.
17 * GNU Zebra is free software; you can redistribute it and/or modify it
18 * under the terms of the GNU General Public License as published by the
19 * Free Software Foundation; either version 2, or (at your option) any
22 * GNU Zebra is distributed in the hope that it will be useful, but
23 * WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 * General Public License for more details.
27 * You should have received a copy of the GNU General Public License along
28 * with this program; see the file COPYING; if not, write to the Free Software
29 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
40 #include "sockunion.h"
48 #include "eigrpd/eigrp_structs.h"
49 #include "eigrpd/eigrpd.h"
50 #include "eigrpd/eigrp_interface.h"
51 #include "eigrpd/eigrp_neighbor.h"
52 #include "eigrpd/eigrp_packet.h"
53 #include "eigrpd/eigrp_zebra.h"
54 #include "eigrpd/eigrp_vty.h"
55 #include "eigrpd/eigrp_dump.h"
56 #include "eigrpd/eigrp_macros.h"
58 /* Packet Type String. */
59 static const struct message eigrp_general_tlv_type_str
[] = {
60 {EIGRP_TLV_PARAMETER
, "PARAMETER"},
61 {EIGRP_TLV_AUTH
, "AUTH"},
62 {EIGRP_TLV_SEQ
, "SEQ"},
63 {EIGRP_TLV_SW_VERSION
, "SW_VERSION"},
64 {EIGRP_TLV_NEXT_MCAST_SEQ
, "NEXT_MCAST_SEQ"},
65 {EIGRP_TLV_PEER_TERMINATION
, "PEER_TERMINATION"},
66 {EIGRP_TLV_PEER_MTRLIST
, "PEER_MTRLIST"},
67 {EIGRP_TLV_PEER_TIDLIST
, "PEER_TIDLIST"},
72 * @fn eigrp_hello_timer
74 * @param[in] thread current execution thread timer is associated with
76 * @return int always returns 0
79 * Called once per "hello" time interval, default 5 seconds
80 * Sends hello packet via multicast for all interfaces eigrp
83 int eigrp_hello_timer(struct thread
*thread
)
85 struct eigrp_interface
*ei
;
87 ei
= THREAD_ARG(thread
);
90 if (IS_DEBUG_EIGRP(0, TIMERS
))
91 zlog_debug("Start Hello Timer (%s) Expire [%u]", IF_NAME(ei
),
94 /* Sending hello packet. */
95 eigrp_hello_send(ei
, EIGRP_HELLO_NORMAL
, NULL
);
97 /* Hello timer set. */
99 thread_add_timer(master
, eigrp_hello_timer
, ei
, ei
->params
.v_hello
,
106 * @fn eigrp_hello_parameter_decode
108 * @param[in] nbr neighbor the ACK should be sent to
109 * @param[in] param pointer packet TLV is stored to
111 * @return uint16_t number of bytes added to packet stream
114 * Encode Parameter TLV, used to convey metric weights and the hold time.
117 * Note the addition of K6 for the new extended metrics, and does not apply to
118 * older TLV packet formats.
120 static struct eigrp_neighbor
*
121 eigrp_hello_parameter_decode(struct eigrp_neighbor
*nbr
,
122 struct eigrp_tlv_hdr_type
*tlv
)
124 struct eigrp
*eigrp
= nbr
->ei
->eigrp
;
125 struct TLV_Parameter_Type
*param
= (struct TLV_Parameter_Type
*)tlv
;
127 /* copy over the values passed in by the neighbor */
134 nbr
->v_holddown
= ntohs(param
->hold_time
);
137 * Check K1-K5 have the correct values to be able to become neighbors
138 * K6 does not have to match
140 if ((eigrp
->k_values
[0] == nbr
->K1
) && (eigrp
->k_values
[1] == nbr
->K2
)
141 && (eigrp
->k_values
[2] == nbr
->K3
)
142 && (eigrp
->k_values
[3] == nbr
->K4
)
143 && (eigrp
->k_values
[4] == nbr
->K5
)) {
145 if (eigrp_nbr_state_get(nbr
) == EIGRP_NEIGHBOR_DOWN
) {
146 zlog_info("Neighbor %s (%s) is pending: new adjacency",
148 ifindex2ifname(nbr
->ei
->ifp
->ifindex
,
151 /* Expedited hello sent */
152 eigrp_hello_send(nbr
->ei
, EIGRP_HELLO_NORMAL
, NULL
);
154 // if(ntohl(nbr->ei->address->u.prefix4.s_addr) >
155 // ntohl(nbr->src.s_addr))
156 eigrp_update_send_init(nbr
);
158 eigrp_nbr_state_set(nbr
, EIGRP_NEIGHBOR_PENDING
);
161 if (eigrp_nbr_state_get(nbr
) != EIGRP_NEIGHBOR_DOWN
) {
162 if ((param
->K1
& param
->K2
& param
->K3
& param
->K4
166 "Neighbor %s (%s) is down: Interface PEER-TERMINATION received",
168 ifindex2ifname(nbr
->ei
->ifp
->ifindex
,
170 eigrp_nbr_delete(nbr
);
174 "Neighbor %s (%s) going down: Kvalue mismatch",
176 ifindex2ifname(nbr
->ei
->ifp
->ifindex
,
178 eigrp_nbr_state_set(nbr
, EIGRP_NEIGHBOR_DOWN
);
187 eigrp_hello_authentication_decode(struct stream
*s
,
188 struct eigrp_tlv_hdr_type
*tlv_header
,
189 struct eigrp_neighbor
*nbr
)
191 struct TLV_MD5_Authentication_Type
*md5
;
193 md5
= (struct TLV_MD5_Authentication_Type
*)tlv_header
;
195 if (md5
->auth_type
== EIGRP_AUTH_TYPE_MD5
)
196 return eigrp_check_md5_digest(s
, md5
, nbr
,
197 EIGRP_AUTH_BASIC_HELLO_FLAG
);
198 else if (md5
->auth_type
== EIGRP_AUTH_TYPE_SHA256
)
199 return eigrp_check_sha256_digest(
200 s
, (struct TLV_SHA256_Authentication_Type
*)tlv_header
,
201 nbr
, EIGRP_AUTH_BASIC_HELLO_FLAG
);
207 * @fn eigrp_sw_version_decode
209 * @param[in] nbr neighbor the ACK shoudl be sent to
210 * @param[in] param pointer to TLV software version information
215 * Read the software version in the specified location.
216 * This consists of two bytes of OS version, and two bytes of EIGRP
219 static void eigrp_sw_version_decode(struct eigrp_neighbor
*nbr
,
220 struct eigrp_tlv_hdr_type
*tlv
)
222 struct TLV_Software_Type
*version
= (struct TLV_Software_Type
*)tlv
;
224 nbr
->os_rel_major
= version
->vender_major
;
225 nbr
->os_rel_minor
= version
->vender_minor
;
226 nbr
->tlv_rel_major
= version
->eigrp_major
;
227 nbr
->tlv_rel_minor
= version
->eigrp_minor
;
232 * @fn eigrp_peer_termination_decode
234 * @param[in] nbr neighbor the ACK shoudl be sent to
235 * @param[in] tlv pointer to TLV software version information
240 * Read the address in the TLV and match to out address. If
241 * a match is found, move the sending neighbor to the down state. If
242 * out address is not in the TLV, then ignore the peer termination
244 static void eigrp_peer_termination_decode(struct eigrp_neighbor
*nbr
,
245 struct eigrp_tlv_hdr_type
*tlv
)
247 struct TLV_Peer_Termination_type
*param
=
248 (struct TLV_Peer_Termination_type
*)tlv
;
250 uint32_t my_ip
= nbr
->ei
->address
->u
.prefix4
.s_addr
;
251 uint32_t received_ip
= param
->neighbor_ip
;
253 if (my_ip
== received_ip
) {
254 zlog_info("Neighbor %s (%s) is down: Peer Termination received",
256 ifindex2ifname(nbr
->ei
->ifp
->ifindex
, VRF_DEFAULT
));
257 /* set neighbor to DOWN */
258 nbr
->state
= EIGRP_NEIGHBOR_DOWN
;
259 /* delete neighbor */
260 eigrp_nbr_delete(nbr
);
265 * @fn eigrp_peer_termination_encode
267 * @param[in,out] s packet stream TLV is stored to
268 * @param[in] nbr_addr pointer to neighbor address for Peer
271 * @return uint16_t number of bytes added to packet stream
274 * Function used to encode Peer Termination TLV to Hello packet.
276 static uint16_t eigrp_peer_termination_encode(struct stream
*s
,
277 struct in_addr
*nbr_addr
)
279 uint16_t length
= EIGRP_TLV_PEER_TERMINATION_LEN
;
281 /* fill in type and length */
282 stream_putw(s
, EIGRP_TLV_PEER_TERMINATION
);
283 stream_putw(s
, length
);
285 /* fill in unknown field 0x04 */
286 stream_putc(s
, 0x04);
288 /* finally neighbor IP address */
289 stream_put_ipv4(s
, nbr_addr
->s_addr
);
295 * @fn eigrp_hello_receive
297 * @param[in] eigrp eigrp routing process
298 * @param[in] iph pointer to ip header
299 * @param[in] eigrph pointer to eigrp header
300 * @param[in] s input ip stream
301 * @param[in] ei eigrp interface packet arrived on
302 * @param[in] size size of eigrp packet
307 * This is the main worker function for processing hello packets. It
308 * will validate the peer associated with the src ip address of the ip
309 * header, and then decode each of the general TLVs which the packet
313 * Not all TLVs are current decoder. This is a work in progress..
315 void eigrp_hello_receive(struct eigrp
*eigrp
, struct ip
*iph
,
316 struct eigrp_header
*eigrph
, struct stream
*s
,
317 struct eigrp_interface
*ei
, int size
)
319 struct eigrp_tlv_hdr_type
*tlv_header
;
320 struct eigrp_neighbor
*nbr
;
324 /* get neighbor struct */
325 nbr
= eigrp_nbr_get(ei
, eigrph
, iph
);
327 /* neighbor must be valid, eigrp_nbr_get creates if none existed */
330 if (IS_DEBUG_EIGRP_PACKET(eigrph
->opcode
- 1, RECV
))
331 zlog_debug("Processing Hello size[%u] int(%s) nbr(%s)", size
,
332 ifindex2ifname(nbr
->ei
->ifp
->ifindex
, VRF_DEFAULT
),
333 inet_ntoa(nbr
->src
));
335 size
-= EIGRP_HEADER_LEN
;
339 tlv_header
= (struct eigrp_tlv_hdr_type
*)eigrph
->tlv
;
342 type
= ntohs(tlv_header
->type
);
343 length
= ntohs(tlv_header
->length
);
345 if ((length
> 0) && (length
<= size
)) {
346 if (IS_DEBUG_EIGRP_PACKET(0, RECV
))
349 lookup_msg(eigrp_general_tlv_type_str
,
352 // determine what General TLV is being processed
354 case EIGRP_TLV_PARAMETER
:
355 nbr
= eigrp_hello_parameter_decode(nbr
,
360 case EIGRP_TLV_AUTH
: {
361 if (eigrp_hello_authentication_decode(
371 case EIGRP_TLV_SW_VERSION
:
372 eigrp_sw_version_decode(nbr
, tlv_header
);
374 case EIGRP_TLV_NEXT_MCAST_SEQ
:
376 case EIGRP_TLV_PEER_TERMINATION
:
377 eigrp_peer_termination_decode(nbr
, tlv_header
);
380 case EIGRP_TLV_PEER_MTRLIST
:
381 case EIGRP_TLV_PEER_TIDLIST
:
388 tlv_header
= (struct eigrp_tlv_hdr_type
*)(((char *)tlv_header
)
395 /*If received packet is hello with Parameter TLV*/
396 if (ntohl(eigrph
->ack
) == 0) {
397 /* increment statistics. */
400 eigrp_nbr_state_update(nbr
);
403 if (IS_DEBUG_EIGRP_PACKET(0, RECV
))
404 zlog_debug("Hello Packet received from %s",
405 inet_ntoa(nbr
->src
));
411 void eigrp_sw_version_initialize(void)
413 char ver_string
[] = VERSION
;
414 char *dash
= strstr(ver_string
, "-");
420 ret
= sscanf(ver_string
, "%" SCNu32
".%" SCNu32
, &FRR_MAJOR
,
423 zlog_err("Did not Properly parse %s, please fix VERSION string",
428 * @fn eigrp_sw_version_encode
430 * @param[in,out] s packet stream TLV is stored to
432 * @return uint16_t number of bytes added to packet stream
435 * Store the software version in the specified location.
436 * This consists of two bytes of OS version, and two bytes of EIGRP
439 static uint16_t eigrp_sw_version_encode(struct stream
*s
)
441 uint16_t length
= EIGRP_TLV_SW_VERSION_LEN
;
443 // setup the tlv fields
444 stream_putw(s
, EIGRP_TLV_SW_VERSION
);
445 stream_putw(s
, length
);
447 stream_putc(s
, FRR_MAJOR
); //!< major os version
448 stream_putc(s
, FRR_MINOR
); //!< minor os version
450 /* and the core eigrp version */
451 stream_putc(s
, EIGRP_MAJOR_VERSION
);
452 stream_putc(s
, EIGRP_MINOR_VERSION
);
458 * @fn eigrp_tidlist_encode
460 * @param[in,out] s packet stream TLV is stored to
465 * If doing mutli-topology, then store the supported TID list.
466 * This is currently a place holder function
468 static uint16_t eigrp_tidlist_encode(struct stream
*s
)
470 // uint16_t length = EIGRP_TLV_SW_VERSION_LEN;
475 * @fn eigrp_sequence_encode
477 * @param[in,out] s packet stream TLV is stored to
479 * @return uint16_t number of bytes added to packet stream
482 * Part of conditional receive process
485 static uint16_t eigrp_sequence_encode(struct stream
*s
)
487 uint16_t length
= EIGRP_TLV_SEQ_BASE_LEN
;
489 struct eigrp_interface
*ei
;
490 struct listnode
*node
, *node2
, *nnode2
;
491 struct eigrp_neighbor
*nbr
;
492 size_t backup_end
, size_end
;
495 eigrp
= eigrp_lookup();
500 // add in the parameters TLV
501 backup_end
= stream_get_endp(s
);
502 stream_putw(s
, EIGRP_TLV_SEQ
);
504 stream_putw(s
, 0x0000);
505 stream_putc(s
, IPV4_MAX_BYTELEN
);
508 for (ALL_LIST_ELEMENTS_RO(eigrp
->eiflist
, node
, ei
)) {
509 for (ALL_LIST_ELEMENTS(ei
->nbrs
, node2
, nnode2
, nbr
)) {
510 if (nbr
->multicast_queue
->count
> 0) {
511 length
+= (uint16_t)stream_put_ipv4(
519 stream_set_endp(s
, backup_end
);
523 backup_end
= stream_get_endp(s
);
524 stream_set_endp(s
, size_end
);
525 stream_putw(s
, length
);
526 stream_set_endp(s
, backup_end
);
532 * @fn eigrp_sequence_encode
534 * @param[in,out] s packet stream TLV is stored to
536 * @return uint16_t number of bytes added to packet stream
539 * Part of conditional receive process
542 static uint16_t eigrp_next_sequence_encode(struct stream
*s
)
544 uint16_t length
= EIGRP_NEXT_SEQUENCE_TLV_SIZE
;
547 eigrp
= eigrp_lookup();
552 // add in the parameters TLV
553 stream_putw(s
, EIGRP_TLV_NEXT_MCAST_SEQ
);
554 stream_putw(s
, EIGRP_NEXT_SEQUENCE_TLV_SIZE
);
555 stream_putl(s
, eigrp
->sequence_number
+ 1);
561 * @fn eigrp_hello_parameter_encode
563 * @param[in] ei pointer to interface hello packet came in on
564 * @param[in,out] s packet stream TLV is stored to
566 * @return uint16_t number of bytes added to packet stream
569 * Encode Parameter TLV, used to convey metric weights and the hold time.
572 * Note the addition of K6 for the new extended metrics, and does not apply to
573 * older TLV packet formats.
575 static uint16_t eigrp_hello_parameter_encode(struct eigrp_interface
*ei
,
576 struct stream
*s
, uint8_t flags
)
578 uint16_t length
= EIGRP_TLV_PARAMETER_LEN
;
580 // add in the parameters TLV
581 stream_putw(s
, EIGRP_TLV_PARAMETER
);
582 stream_putw(s
, EIGRP_TLV_PARAMETER_LEN
);
584 // if graceful shutdown is needed to be announced, send all 255 in K
586 if (flags
& EIGRP_HELLO_GRACEFUL_SHUTDOWN
) {
587 stream_putc(s
, 0xff); /* K1 */
588 stream_putc(s
, 0xff); /* K2 */
589 stream_putc(s
, 0xff); /* K3 */
590 stream_putc(s
, 0xff); /* K4 */
591 stream_putc(s
, 0xff); /* K5 */
592 stream_putc(s
, 0xff); /* K6 */
593 } else // set k values
595 stream_putc(s
, ei
->eigrp
->k_values
[0]); /* K1 */
596 stream_putc(s
, ei
->eigrp
->k_values
[1]); /* K2 */
597 stream_putc(s
, ei
->eigrp
->k_values
[2]); /* K3 */
598 stream_putc(s
, ei
->eigrp
->k_values
[3]); /* K4 */
599 stream_putc(s
, ei
->eigrp
->k_values
[4]); /* K5 */
600 stream_putc(s
, ei
->eigrp
->k_values
[5]); /* K6 */
603 // and set hold time value..
604 stream_putw(s
, ei
->params
.v_wait
);
610 * @fn eigrp_hello_encode
612 * @param[in] ei pointer to interface hello packet came in on
613 * @param[in] s packet stream TLV is stored to
614 * @param[in] ack if non-zero, neigbors sequence packet to ack
615 * @param[in] flags type of hello packet
616 * @param[in] nbr_addr pointer to neighbor address for Peer
619 * @return eigrp_packet pointer initialize hello packet
622 * Allocate an EIGRP hello packet, and add in the the approperate TLVs
625 static struct eigrp_packet
*eigrp_hello_encode(struct eigrp_interface
*ei
,
626 in_addr_t addr
, uint32_t ack
,
628 struct in_addr
*nbr_addr
)
630 struct eigrp_packet
*ep
;
631 uint16_t length
= EIGRP_HEADER_LEN
;
633 // allocate a new packet to be sent
634 ep
= eigrp_packet_new(EIGRP_PACKET_MTU(ei
->ifp
->mtu
), NULL
);
637 // encode common header feilds
638 eigrp_packet_header_init(EIGRP_OPC_HELLO
, ei
->eigrp
, ep
->s
, 0,
641 // encode Authentication TLV
642 if ((ei
->params
.auth_type
== EIGRP_AUTH_TYPE_MD5
)
643 && (ei
->params
.auth_keychain
!= NULL
)) {
644 length
+= eigrp_add_authTLV_MD5_to_stream(ep
->s
, ei
);
645 } else if ((ei
->params
.auth_type
== EIGRP_AUTH_TYPE_SHA256
)
646 && (ei
->params
.auth_keychain
!= NULL
)) {
647 length
+= eigrp_add_authTLV_SHA256_to_stream(ep
->s
, ei
);
650 /* encode appropriate parameters to Hello packet */
651 if (flags
& EIGRP_HELLO_GRACEFUL_SHUTDOWN
)
652 length
+= eigrp_hello_parameter_encode(
653 ei
, ep
->s
, EIGRP_HELLO_GRACEFUL_SHUTDOWN
);
655 length
+= eigrp_hello_parameter_encode(
656 ei
, ep
->s
, EIGRP_HELLO_NORMAL
);
658 // figure out the version of code we're running
659 length
+= eigrp_sw_version_encode(ep
->s
);
661 if (flags
& EIGRP_HELLO_ADD_SEQUENCE
) {
662 length
+= eigrp_sequence_encode(ep
->s
);
663 length
+= eigrp_next_sequence_encode(ep
->s
);
666 // add in the TID list if doing multi-topology
667 length
+= eigrp_tidlist_encode(ep
->s
);
669 /* encode Peer Termination TLV if needed */
670 if (flags
& EIGRP_HELLO_GRACEFUL_SHUTDOWN_NBR
)
672 eigrp_peer_termination_encode(ep
->s
, nbr_addr
);
677 // set soruce address for the hello packet
678 ep
->dst
.s_addr
= addr
;
680 if ((ei
->params
.auth_type
== EIGRP_AUTH_TYPE_MD5
)
681 && (ei
->params
.auth_keychain
!= NULL
)) {
682 eigrp_make_md5_digest(ei
, ep
->s
,
683 EIGRP_AUTH_BASIC_HELLO_FLAG
);
684 } else if ((ei
->params
.auth_type
== EIGRP_AUTH_TYPE_SHA256
)
685 && (ei
->params
.auth_keychain
!= NULL
)) {
686 eigrp_make_sha256_digest(ei
, ep
->s
,
687 EIGRP_AUTH_BASIC_HELLO_FLAG
);
691 eigrp_packet_checksum(ei
, ep
->s
, length
);
698 * @fn eigrp_hello_send
700 * @param[in] nbr neighbor the ACK should be sent to
705 * Send (unicast) a hello packet with the destination address
706 * associated with the neighbor. The eigrp header ACK feild will be
707 * updated to the neighbor's sequence number to acknolodge any
708 * outstanding packets
710 void eigrp_hello_send_ack(struct eigrp_neighbor
*nbr
)
712 struct eigrp_packet
*ep
;
714 /* if packet succesfully created, add it to the interface queue */
715 ep
= eigrp_hello_encode(nbr
->ei
, nbr
->src
.s_addr
,
716 nbr
->recv_sequence_number
, EIGRP_HELLO_NORMAL
,
720 if (IS_DEBUG_EIGRP_PACKET(0, SEND
))
721 zlog_debug("Queueing [Hello] Ack Seq [%u] nbr [%s]",
722 nbr
->recv_sequence_number
,
723 inet_ntoa(nbr
->src
));
725 /* Add packet to the top of the interface output queue*/
726 eigrp_fifo_push(nbr
->ei
->obuf
, ep
);
728 /* Hook thread to write packet. */
729 if (nbr
->ei
->on_write_q
== 0) {
730 listnode_add(nbr
->ei
->eigrp
->oi_write_q
, nbr
->ei
);
731 nbr
->ei
->on_write_q
= 1;
733 thread_add_write(master
, eigrp_write
, nbr
->ei
->eigrp
,
734 nbr
->ei
->eigrp
->fd
, &nbr
->ei
->eigrp
->t_write
);
739 * @fn eigrp_hello_send
741 * @param[in] ei pointer to interface hello should be sent
742 * @param[in] flags type of hello packet
743 * @param[in] nbr_addr pointer to neighbor address for Peer
749 * Build and enqueue a generic (multicast) periodic hello packet for
750 * sending. If no packets are currently queues, the packet will be
753 void eigrp_hello_send(struct eigrp_interface
*ei
, uint8_t flags
,
754 struct in_addr
*nbr_addr
)
756 struct eigrp_packet
*ep
= NULL
;
758 /* If this is passive interface, do not send EIGRP Hello.
759 if ((EIGRP_IF_PASSIVE_STATUS (ei) == EIGRP_IF_PASSIVE) ||
760 (ei->type != EIGRP_IFTYPE_NBMA))
764 if (IS_DEBUG_EIGRP_PACKET(0, SEND
))
765 zlog_debug("Queueing [Hello] Interface(%s)", IF_NAME(ei
));
767 /* if packet was succesfully created, then add it to the interface queue
769 ep
= eigrp_hello_encode(ei
, htonl(EIGRP_MULTICAST_ADDRESS
), 0, flags
,
773 // Add packet to the top of the interface output queue
774 eigrp_fifo_push(ei
->obuf
, ep
);
776 /* Hook thread to write packet. */
777 if (ei
->on_write_q
== 0) {
778 listnode_add(ei
->eigrp
->oi_write_q
, ei
);
782 if (ei
->eigrp
->t_write
== NULL
) {
783 if (flags
& EIGRP_HELLO_GRACEFUL_SHUTDOWN
) {
784 thread_execute(master
, eigrp_write
, ei
->eigrp
,
787 thread_add_write(master
, eigrp_write
, ei
->eigrp
,
789 &ei
->eigrp
->t_write
);