Ethernet V2.0 Configuration Testing Protocol (ECTP) Mark Smith, <markzzzsmith@yahoo.com.au> 1. Introduction The Ethernet V2.

0 Configuration Testing Protocol (ECTP) is an Ethernet link layer testing protocol. It supports: o unicast testing - an ethernet layer "ping". This can include a strict source route - a list of stations to visit during the test. o broadcast or multicast discovery of ECTP "loopback assistants". The discovered stations can then be used for unicast testing, either as unicast test destinations, or as part of the strict source route. ECTP is specified in Section 8, "Ethernet Configuration Testing Protocol", page 85 of "The Ethernet - A Local Area Network - Data Link Layer and Physical Layer Specifications" DEC, Intel, Xerox, Version 2.0, November 1982. ECTP is also known as the "Loop", "LOOP", "Loopback" protocol or "Configuration Test Protocol (CTP)." According to the Ethernet V2.0 specification, "All Ethernet stations must support the configuration testing functions." 2. ECTP description ECTP is a simple protocol, consisting of a single packet format. ECTP packets are carried directly in an Ethernet frame, with an Ethernet frame type of 0x9000. An ECTP packet contains a sequence of messages. There are two types of messages in the sequence: o one or more forward messages o a single reply message The first field of an ECTP packet is the skipcount field. Upon receipt of an ECTP packet, this two octet field points to the "current" message - the message the recipient is expected to process. The value of the skipcount field starts at zero, with zero representing or pointing to the first octet of the first message in the ECTP packet. As a ECTP packet is processed by each station, the skipcount field is incremented to point to the first octet of the next message in the ECTP packet, just before it is transmitted. The first two octets of an ECTP message specifies the message or "function" type - a forward message has a type value of 0x0002, while a reply message has a type value of 0x0001. No other message types are specified. A forward message then specifies the six octet station address (MAC address) the receiving station should next forward the ECTP packet to. The specified station address must be a unicast address. Combining the size of the message function type field with the size of the station address carried in a forward message results in a total forward message size of 8 octets. Consequently, as the ECTP packet is forwarded, the skipcount will increase in increments of 8, starting at zero. Therefore, a valid

sequence of skipcount values would be 0, 8, 16, 24, corresponding to 3 forward messages and a reply message. A reply message is intended to be processed by the station specified in the last forward message. The first field is a two octet receipt number, which can be used to identify the receiving process on the recipient, or for some other identification value useful to the receiver. The receipt number field is not modified during transmission. Following the receipt number field is an arbitrary length payload, up to the maximum supported Ethernet frame size. Should the size of the receipt message and it's payload, combined with the length of any preceeding forward messages, not exceed the minimum Ethernet frame size of 64 octet, Ethernet padding will be added to the abitrary payload when it is transmitted. As there is no ECTP length field, upon receipt, it is not possible to determine where the arbitrary payload stops and the Ethernet padding started, unless the sending process maintains that information independently. Otherwise, the arbitrary payload is not modified during transmission. The minimum compliant ECTP packet consists of a single forward message followed by a single reply message. Typically the forward message would specify the station address of the ECTP packet originator. The destination station address in the Ethernet header of this ECTP packet could either be a unicast, broadcast or multicast destination. The reserved multicast address for ECTP is cf:00:00:00:00:00. The arbitrary payload size for this minimal packet should be at least 32 octets; as mentioned before, Ethernet padding will be added to short frames upon transmission. Should the destination address of an ECTP packet be either the broadcast or the multicast address, the message type following the current message - the one pointed to by the skipcount field upon receipt - is prohibited from being anything other than a reply message. This means that a typical broadcast or multicast ECTP packet would consist of a single forward message, specifying the unicast station address of the ECTP packet originator, and a reply message. The network order for ECTP numeric fields (skipcount, message function type) is little endian, the opposite network order to IPv4. As the reply message receipt number is not processed by the ECTP protocol itself, the endianness of this field is arbitrary. So, in summary, o ECTP consists of a single packet format o ECTP packets are carried in Ethernet type 0x9000 frames o ECTP packets contain a skipcount field and a series of messages o the skipcount field, upon receipt, points to the current message to be processed o immediatly prior to transmission, the skipcount field is incremented by 8, so that the next message becomes the current message upon receipt at the next station o there are two message types - a forward message and a reply message o ECTP packets contain one or more forward messages, and a reply message

o a forward message specifies the unicast station or MAC address the ECTP packet should next be forwarded to o a reply message carries an receipt number, typically to identify the receiving process, and an arbitrary payload o ECTP packets can be sent to unicast, broadcast, or the ECTP reserved cf:00:00:00:00:00 multicast address o The message type of the next message after the current message in broadcast or multicast ECTP packets is restricted to being a reply message o For ECTP numeric fields, the network order is little endian, the opposite to the network order of IPv4 3. Features and details of this implementation 3.1 Only an ECTP forwarder/responder Similar to most ICMP Echo Request/Reply ("ping") implementations, this implementation is only an ECTP forwarder/responder. There is no kernel sockets interface to the protocol - user space programs will have send or receive the ECTP packets using PF_PACKET sockets. 3.2 Varied delay responses to broadcast or multicast ECTP packets When a group of stations receive a broadcast or multicast ECTP packet, should they all reply immediately, there is possibility that some of the unicast responses could get lost. This loss could occur either due to congestion occuring on the Ethernet segment, or due to the receiving station being overwhelmed by the volume of responses and consequently ignoring some of them. To mitigate this problem, this implementation delays it's responses to broadcast or multicast ECTP packets. The delay length is made up of a sum of two time periods: o a minimum fixed number of milliseconds o a random number of milliseconds The minimum fixed number of millisecond delay tries to ensure that this implementation's responses do not collide with responses from other implementations that don't delay their responses. The random number of milliseconds delay component then tries to ensure that responses from this implementation do not collide. In networking terms, varying delays between packet arrival times is known as "jitter". The default fixed number of milliseconds is 10, while the default random number of millisecond delay ranges from 0 to 63 milliseconds. The fixed delay milliseconds parameter can be changed via the

net.ectp.bmc_jitter_min_msecs sysctl, or the /proc/sys/net/ectp/bmc_jitter_min_msecs file. The range of acceptable values is 0 through 1000 milliseconds. The random delay parameter is specified as a bitmask length that is applied to a random number. This parameter can be changed via the net.ectp.bmc_jitter_randmask_len sysctl, or the /proc/sys/net/ectp/bmc_jitter_randmask_len file. The range of acceptable values for the bitmask length is 0 through 10. The default value is 6 bits, resulting in the default random delay range of 0 through 63 milliseconds. The maximum value of 10 would result in a random delay range of 0 through to 1023 milliseconds. Due to delaying respones, there could be a number of outstanding responses pending. These pending responses are queued. Once the queue is full, any new incoming broadcast or multicast ECTP packets are ignored. The default depth of the queue is 10 delayed responses. This parameter can be changed via the net.ectp.bmc_rply_q_maxlen sysctl, or the /proc/sys/net/ectp/bmc_rply_q_maxlen file. The range of acceptable values for the reply queue depth is 0 through 30. 3.3 Ignore broadcast and multicast ECTP Packets By default, this implementation responds to broadcast and multicast (bmc) ECTP packets. This can be disabled by setting the net.ectp.bmc_ignore sysctl, or the /proc/sys/net/ectp/bmc_ignore file to 1. To enable responding to broadcast and multicast ECTP packets, set the value to 0. 3.4 Ignore unicast ECTP packets By default, this implementation reponds to unicast ECTP packets. This can be disabled by setting the net.ectp.uc_ignore

sysctl, or the /proc/sys/net/ectp/uc_ignore file to 1. To enable responding to unicast ECTP packets, set the value to 0. 3.5 Set responses to unicast ECTP packets to TC_PRIO_CONTROL Responses to unicast ECTP packets are set to TC_PRIO_BESTEFFORT by default. Should the outbound interface be transmitting a large amount of traffic, this could result in them getting significantly delayed behind other traffic, or possibly even dropped from the outbound interface queue. Setting their priority to TC_PRIO_CONTROL will help prevent this, as it identifies these responses as control rather than best effort traffic, although how TC_PRIO_BESTEFFORT and TC_PRIO_CONTROL marked traffic is handled does depend on the packet scheduler assigned to the outbound interface. Setting the priority to TC_PRIO_CONTROL may be useful if ECTP is being used to monitor availability. To change the unicast response priority from TC_PRIO_BESTEFFORT to TC_PRIO_CONTROL, change the net.ectp.uc_rply_prio_ctrl sysctl, or the /proc/sys/net/ectp/uc_rply_prio_ctrl file to 1. To switch back to TC_PRIO_BESTEFFORT, set the value to 0. 4. Security ECTP was designed in the early 1980s, when protocol security was less of a concern than it is now. Consequently, there are some features of the protocol which could be abused for nefarious purposes. By default, this implementation attempts to avoid participating in them. These features could be useful for some test cases thought, so they can be enabled if required. 4.1 Traffic amplification An ECTP packet could be sent to either the broadcast or multicast address, with a forwarding address that doesn't match the ECTP packet source. Should the receiving ECTP implementations respond to this broadcast or multicast ECTP packet immediately, the station at the specified forward address would suffer from a large influx of unexpected unicast ECTP packets. Alternatively, if the specified forward address does not exist, in an Ethernet switched environment, all the ECTP responses would be flooded to all ports on the switch, excepting the port the ECTP response arrived on. By default, this implementation will not respond to ECTP broadcast, multicast or unicast packets that specify a forward address that doesn't match the ECTP packet's source MAC address. This prevents this implementation participating in a traffic amplification attack. The net.ectp.src_rt_max_fwdmsgs sysctl, described below, can be used to change this behaviour.

4.2 Non-local source route loops The source route capability of ECTP can be exploited to create a traffic based denial of service attack, involving two or more remote stations. In the simplest scenario, the attacking station, station A, creates an ECTP packet containing a large number of forward messages. The forward messages specify alternating station B and station C addresses, with station B and C being both unwilling participants and victims. Station A then sends the packet to B. B will send the packet to C, which will then send it back to B, which then sends it back to C, and so on. This looping will continue as fast as B and C can process the received ECTP packets, until the sequence of forward messages in the ECTP packet is exhausted. With the common Ethernet default MTU of 1500 octets, and a forwarding message size of 8 octet, a source route could contain a loop with 187 hops. Non-standard 9000 octet MTU Ethernet frames could contain a source route with 1124 hops. More complicated exploits would involve specifying more than 2 remote stations to participate in the loop, and rapidly sending a number of ECTP packets with looped source routes, such that multiple concurrent forwarding loops occur. To avoid participating in source route forwarding loops, this implementation, by default, will only process ECTP packets with a single forward message. ECTP packets with more than one forward message will be silently dropped. The net.ectp.src_rt_max_fwdmsgs sysctl, described below, can be used allow this implementation to participate in source routes that consist of more than one forward message, should that be required for testing purposes. 4.3 net.ectp.src_rt_max_fwdmsgs sysctl The net.ectp.src_rt_max_fwdmsgs sysctl is used to control source address validation of single forward message ECTP packets, described previously in 4.1, and to specify the maximum number of forward messages in a source route that this implementation will process, described in 4.2. The default value of 0 specifies that only single forward message ECTP packets will be processed, and will only be further forwarded if the forward address matches the original ECTP packet's source. Values greater than 0 specify the maximum number of forward messages that this implementation will process, with a maximum value of 1000. It is important to realise that this implementation does not count the number of forward messages in the received packet to determine if it should forward the packet futher. Instead, it uses the skipcount field's current value to determine if current forward message is one which exceeds the current net.ectp.src_rt_max_fwdmsgs value. The /proc file corresponding to the net.ectp.src_rt_max_fwdmsgs sysctl is /proc/sys/net/ectp/net.ectp.src_rt_max_fwdmsgs 5. ECTP References

5.1 "The Ethernet - A Local Area Network - Data Link Layer and Physical Layer Specifications", Version 2.0, November 1982, (DEC, Intel, Xerox), (Digital Equipment Corp Part# AA-K759B-TK). Available at (as of January 2008): A Xerox version - (around 7MB) http://bitsavers.org/pdf/xerox/ethernet/Ethernet_Rev2.0_Nov1982.pdf A DEC version - (warning - around 33MB!) http://vt100.net/mirror/antonio/aa-k759b-tk.pdf 5.2 "DECnet Maintenance Operations Functional Specification", Version 3.0.0, September 1983, Appendix E, "ETHERNET LOOP TESTING" This is different text to the Ethernet V2.0 specification above. Available at (as of February 2008): http://linux-decnet.sourceforge.net/docs/maintop30.txt 5.3 Ethernet configuration testing protocol (CTP) A page describing how John Hawkinson found details details of the protocol. He has scanned the ECTP protocol pages of the Ethernet V2.0 spec, providing a PDF. This was the first source of ECTP protocol information I used. Available at (as of February 2009): http://www.mit.edu/people/jhawk/ctp.html The direct link to the PDF is: http://www.mit.edu/people/jhawk/ctp.pdf 6. Other ECTP related information 6.1 Wireshark support Wireshark can decode it. Details and a sample capture are at (as of February 2009): http://wiki.wireshark.org/Loop 6.2 "Monitoring Ethernet Connectivity" A HP Labs paper describing how ECTP was used for ethernet testing and monitoring at Carnegie Mellon University in the mid-80s, titled "Monitoring Ethernet Connectivity", report HPL-2003-160, is available at (as of February 2009): http://www.hpl.hp.com/techreports/2003/HPL-2003-160.html 7. Acknowledgements and Bibliography

o John Hawkinson for originally finding and putting a copy of the ECTP spec online. o Rusty Russell's "Unreliable Guide To Locking". Table 5.1, "Table of Minimum Requirements" is very useful for working out what type of spinlock to use when softirqs, kernel timers and notifiers can occur concurrently. Available at: http://www.kernel.org/pub/linux/kernel/people/rusty/\ kernel-locking/index.html o "Understanding Linux Network Internals", by Christian Benvenuti. Copyright 2006 O'Reilly Media, Inc., ISBN: 0-596-00255-6 o "Linux Device Drivers", 2nd Edition, by Allesandro Rubini and Jonathan Corbet. Copyright 2001, 1998 O'Reilly and Associates, Inc., ISBN: 0-596-00008-1 o The various authors of the Linux subsystems and networking protocols. o "Network Algorithmics", by George Varghese, Copyright 2005, Elsevier, ISBN-13: 978-0-12-088477-3, ISBN-10: 0-12-088477-1 o Donald Robinson Smith, my Father. diff --git a/MAINTAINERS b/MAINTAINERS index 5d460c9..3411281 100644 --- a/MAINTAINERS ++ b/MAINTAINERS @@ -1683,6 +1683,11 @@ L: bridge@lists.linux-foundation.org <mailto:bridge @lists.linux-foundation.org> W: http://www.linux-foundation.org/en/Net:Bridge S: Maintained ETHERNET CONFIGURATION TESTING PROTOCOL P: Mark Smith M: markzzzsmith@yahoo.com.au <mailto:markzzzsmith@yahoo.com.au> S: Maintained ETHERTEAM 16I DRIVER P: Mika Kuoppala M: miku@iki.fi <mailto:miku@iki.fi> diff --git a/include/linux/ectp.h b/include/linux/ectp.h new file mode 100644 index 0000000..104c3c1 --- /dev/null ++ b/include/linux/ectp.h @@ -0,0 +1,108 @@ #ifndef _NET_INET_ECTP_H_ #define _NET_INET_ECTP_H_ /* * * * * */ ectp.h Ethernet Configuration Testing Protocol (ECTP) defines and structures

#include <linux/types.h>

#include <linux/if_ether.h> /* * ECTP loopback assistance multicast address */ #define ECTP_LA_MCADDR { 0xCF, 0x00, 0x00, 0x00, 0x00, 0x00 } /* * Function Code field values */ enum { ECTP_RPLYMSG ECTP_FWDMSG }; /* * ECTP packet structures */ /* * ECTP common header - only * field. * * note: skipcount is little * network order - don't use * on it, because they won't */ struct ectp_packet_header { uint16_t skipcount; } __attribute__ ((packed)); = 1, = 2, /* Reply message */ /* Forward message */

consists of the single 2 octet skip count endian, i.e. _not_ traditional big endian traditional ntohs() or htons() functions work.

/* * ECTP packet */ struct ectp_packet { struct ectp_packet_header hdr; uint8_t payload[]; } __attribute__ ((packed)); /* * ECTP Message Header */ struct ectp_message_header { uint16_t func_code; } __attribute__ ((packed)); /* * ECTP Reply Message (minus Function Code field) */ struct ectp_reply_message { uint16_t rcpt_num; uint8_t data[];

} __attribute__ ((packed)); /* * ECTP Forward Message (minus Function Code field) */ struct ectp_forward_message { uint8_t fwdaddr[ETH_ALEN]; } __attribute__ ((packed)); /* * ECTP Message */ struct ectp_message { struct ectp_message_header hdr; union { struct ectp_forward_message fwd_msg; struct ectp_reply_message rply_msg; }; } __attribute__ ((packed)); /* * ECTP protocol header sizes */ enum { ECTP_SKIPCOUNT_HDR_SZ ECTP_MSG_HDR_SZ ECTP_FWDMSG_SZ ECTP_REPLYMSG_MINSZ }; #endif /* _NET_INET_ECTP_H_ */ /* EOF */ diff --git a/include/linux/if_ether.h b/include/linux/if_ether.h index 7f3c735..bc27813 100644 --- a/include/linux/if_ether.h ++ b/include/linux/if_ether.h @@ -78,6 +78,7 @@ #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */ #define ETH_P_AOE 0x88A2 /* ATA over Ethernet */ #define ETH_P_TIPC 0x88CA /* TIPC */ #define ETH_P_ECTP 0x9000 /* ECTP a.k.a. LOOP */ #define ETH_P_EDSA 0xDADA /* Ethertype DSA [ NOT AN OFFICIALLY REG ISTERED ID ] */ /* diff --git a/net/Kconfig b/net/Kconfig index cdb8fde..399539a 100644 --- a/net/Kconfig ++ b/net/Kconfig @@ -230,6 +230,7 @@ source "net/irda/Kconfig" source "net/bluetooth/Kconfig" source "net/rxrpc/Kconfig" source "net/phonet/Kconfig" source "net/ectp/Kconfig"

= = = =

sizeof(struct sizeof(struct sizeof(struct sizeof(struct

ectp_packet_header), ectp_message_header), ectp_forward_message), ectp_reply_message),

config FIB_RULES bool diff --git a/net/Makefile b/net/Makefile index 0fcce89..3117cfb 100644 --- a/net/Makefile ++ b/net/Makefile @@ -44,6 +44,7 @@ obj-$(CONFIG_ATM) += atm/ obj-$(CONFIG_DECNET) += decnet/ obj-$(CONFIG_ECONET) += econet/ obj-$(CONFIG_PHONET) += phonet/ obj-$(CONFIG_ECTP) += ectp/ ifneq ($(CONFIG_VLAN_8021Q),) obj-y += 8021q/ endif diff --git a/net/ectp/Kconfig b/net/ectp/Kconfig new file mode 100644 index 0000000..516968a --- /dev/null ++ b/net/ectp/Kconfig @@ -0,0 +1,34 @@ # # Ethernet V2.0 Configuration Testing Protocol # config ECTP tristate "Ethernet V2.0 Configuration Testing Protocol" depends on NET && NET_ETHERNET ---help--The Ethernet V2.0 Configuration Testing Protocol (ECTP) is an Ethernet link layer testing protocol. It supports: o unicast testing - an ethernet layer "ping". This can include a strict source route - a list of stations to visit during the test. o broadcast or multicast discovery of ECTP "loopback assistants". The discovered stations can then be used for unicast testing, either as unicast test destinations, or as part of the strict source route. "The Ethernet", Version 2.0 (1982) specification states that "All Ethernet stations must support the configuration testing functions." (Section 8, page 85) An overview of the protocol, features of this implementation and a number of references, including URLs for the Ethernet V2.0 specification, are provided in the file <linux src>/Documentation/networking/ectp.txt A proof of concept testing utility, "ectpping", is available at: <http://ectpping.<to be added>> The name of the kernel module is "ectp". diff --git a/net/ectp/Makefile b/net/ectp/Makefile new file mode 100644 index 0000000..43c5a9f --- /dev/null ++ b/net/ectp/Makefile @@ -0,0 +1,7 @@

# # Makefile for ECTP support. # obj-$(CONFIG_ECTP) += ectp.o ectp-objs := af_ectp.o diff --git a/net/ectp/af_ectp.c b/net/ectp/af_ectp.c new file mode 100644 index 0000000..d86dd89 --- /dev/null ++ b/net/ectp/af_ectp.c @@ -0,0 +1,2247 @@ /* * af_ectp.c: * * An implementation of the Ethernet v2.0 Configuration Testing Protocol * (ECTP). * * copyright: * * Copyright (C) 2008-2009, Mark Smith <markzzzsmith@yahoo.com.au> * All rights reserved. * * license: * * GPLv2 only * */ #include <asm/byteorder.h> #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include <linux/types.h> <linux/cache.h> <linux/kernel.h> <linux/init.h> <linux/module.h> <linux/spinlock.h> <linux/time.h> <linux/ktime.h> <linux/hrtimer.h> <linux/notifier.h> <linux/interrupt.h> <linux/net.h> <linux/rtnetlink.h> <linux/netdevice.h> <linux/pkt_sched.h> <linux/etherdevice.h> <linux/if_ether.h> <linux/if_arp.h>

#include <linux/ectp.h> #ifdef CONFIG_SYSCTL #include <linux/sysctl.h> #endif /* CONFIG_SYSCTL */ #define MOD_DESC "Ethernet V2.0 Configuration Testing Protocol"

MODULE_DESCRIPTION(MOD_DESC); MODULE_VERSION("0.99"); MODULE_AUTHOR("Mark Smith <markzzzsmith@yahoo.com.au>"); MODULE_LICENSE("GPL v2"); /* * */

*** struct and enum definitions ***

/* * generic skb queue */ struct ectp_skb_queue { spinlock_t spinlock; struct sk_buff_head head; unsigned int maxlen; }; /* * high res timer reply queue */ struct ectp_reply_queue { struct ectp_skb_queue skb_q; struct hrtimer q_hrt_kernt; struct tasklet_struct q_tasklet; bool resched_q_kernt; }; /* * Return values for ectp_nonlinear_skb_ok() */ enum ectp_nonl_skb_ok { ECTP_NONL_SKB_OK, ECTP_NONL_SKB_DROP, ECTP_NONL_SKB_BAD }; /* * */

*** function prototypes ***

/* * module initialisation */ static int __init ectp_init(void); static void __init ectp_init_ktimes(void); static void __init ectp_setup_bmc_rply_q(void); static void __init ectp_init_skb_q(struct ectp_skb_queue *skb_q, const unsigned int q_maxlen); static void __init ectp_setup_rply_q_hrt(struct ectp_reply_queue *rply_q, enum hrtimer_restart (*kernt_func)

(struct hrtimer *)); static void __init ectp_setup_ifaces(void); static void __init ectp_register_ifaces_notif(void); static void __init ectp_register_packet_hdlr(void); static void __init ectp_register_sysctl(void); static void __init ectp_print_banner(void); /* * module exit */ static void __exit ectp_exit(void); static void __exit ectp_unregister_sysctl(void); static void __exit ectp_unregister_packet_hdlr(void); static void __exit ectp_reset_ifaces(void); static void __exit ectp_unregister_ifaces_notif(void); static void __exit ectp_allifaces_del_la_mcaddr(void); static void __exit ectp_shutdown_bmc_rply_q(void); static void __exit ectp_allifaces_netdev_put(void); /* * interface related */ static void ectp_netdev_add_la_mcaddr(struct net_device *netdev); static void ectp_netdev_del_la_mcaddr(struct net_device *netdev); static int ectp_iface_notif_hdlr(struct notifier_block *nb, unsigned long event, void *ptr); static void ectp_rply_q_purge_skb_netdev(struct ectp_reply_queue *rply_q, const struct net_device *netdev); static void ectp__move_netdev_skbs(struct sk_buff_head *from_skb_q, struct sk_buff_head *to_skb_q, const struct net_device *netdev); /* * incoming packet handling */ static int ectp_rcv(struct sk_buff *skb, struct net_device *netdev, struct packet_type *pt, struct net_device *orig_netdev); static bool ectp_la_mcaddr_dst_ok(const struct sk_buff *skb);

static bool ectp_linear_skb_ok(const struct sk_buff *skb, const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int pkt_type); static bool ectp_skipcount_valid(const unsigned int skipcount, const unsigned int msgs_len); static unsigned int ectp_skipc_to_num_fwdmsgs(const unsigned int skipcount); static bool ectp_full_fwdmsg_avail(const unsigned int msgs_len, const unsigned int skipcount); static bool ectp_fwdmsg_chk_ok(const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int rxed_pkt_type, const uint8_t srcmac[ETH_ALEN], const unsigned int skipcount, const uint8_t fwdaddr[ETH_ALEN]); static void ectp_log_bad_fwdmsg(const const const const static bool ectp_fwdaddr_chk_ok(const const const const unsigned int skipcount, uint8_t bad_fwdaddr[ETH_ALEN], uint8_t srcmac[ETH_ALEN], unsigned char rx_netdev_name[IFNAMSIZ]); uint8_t fwdaddr[ETH_ALEN], unsigned int skipcount, uint8_t srcmac[ETH_ALEN], unsigned char rx_netdev_name[IFNAMSIZ]);

static bool ectp_srcmac_rpf_chk_ok(const uint8_t srcmac[ETH_ALEN], const uint8_t fwdaddr[ETH_ALEN]); static bool ectp_srcmac_fwdaddr_match(const uint8_t srcmac[ETH_ALEN], const uint8_t fwdaddr[ETH_ALEN]); static bool ectp_next_msgtype_avail(const unsigned int skipcount, const unsigned int msgs_len); static bool ectp_bmc_nextmsg_chk_ok(const struct ectp_packet *ectp_pkt, const unsigned int skipcount, const unsigned int rxed_pkt_type, const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]); static void ectp_log_bad_bmc(const unsigned int rxed_pkt_type, const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]); static enum ectp_nonl_skb_ok ectp_nonlinear_skb_ok(struct sk_buff **skb_p, const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int pkt_type); static bool ectp_private_skb_ok(struct sk_buff **skb_p); static bool ectp_pskb_pull_ok(struct sk_buff *skb,

const unsigned int pull_len, struct ectp_packet **ectp_pkt_p, struct ectp_message **ectp_curr_msg_p, struct ethhdr **ectp_ethhdr_p); /* * building and sending outgoing frames */ static bool ectp_send_frame_ok(const int rxed_pkt_type, struct sk_buff *rx_skb); static ktime_t ectp_bmc_delay(void); static ktime_t ectp_ms_to_ktime(const unsigned int msecs); static bool ectp_build_tx_skb_ok(struct sk_buff *rx_skb, struct sk_buff **tx_skb_p, const uint32_t tx_prio); static bool ectp_build_delayed_tx_skb_ok(struct sk_buff *rx_skb, struct sk_buff **tx_skb_p, const uint32_t tx_prio, const ktime_t delay); static void ectp_queue_delayed_tx_skb(struct ectp_reply_queue *rply_q, struct sk_buff *tx_skb); static bool ectp__skb_q_full(struct ectp_skb_queue *skb_q); static void ectp_rply_q_kernt_start(struct ectp_reply_queue *rply_q, const ktime_t start_ktime); static void ectp_rply_q_kernt_try_resched(struct ectp_reply_queue *rply_q, const ktime_t start_ktime); static void ectp_rply_q_kernt_try_stop(struct ectp_reply_queue *rply_q); static void ectp_rply_q_kernt_stop(struct ectp_reply_queue *rply_q); static enum hrtimer_restart ectp_bmc_sched_tasklet(struct hrtimer *timer); static void ectp_bmc_tx_skb(unsigned long data); #ifdef CONFIG_SYSCTL /* * sysctl / /proc/sys/net/ectp handlers */ static int ectp_sysctl_bmc_rply_jttr_randmask_len(ctl_table *table, int write, struct file *filp, void __user *buffer, size_t *lenp, loff_t *ppos); static int ectp_sysctl_uc_prio_ctrl(ctl_table *table, int write, struct file *filp, void __user *buffer, size_t *lenp,

loff_t *ppos); static int ectp_sysctl_bmc_rply_jttr_min_msecs(ctl_table *table, int write, struct file *filp, void __user *buffer, size_t *lenp, loff_t *ppos); #endif /* CONFIG_SYSCTL */ /* * ECTP packet utility functions */ static inline uint16_t ectp_htons(uint16_t i); static inline uint16_t ectp_ntohs(uint16_t i); static unsigned int ectp_get_skipcount(const struct ectp_packet *ectp_pkt); static void ectp_set_skipcount(struct ectp_packet *ectp_pkt, const unsigned int skipcount); static struct ectp_message *ectp_get_msg_ptr(const unsigned int skipcount, const struct ectp_packet *ectp_pkt); static struct ectp_message *ectp_get_curr_msg_ptr(const struct ectp_packet *ectp_pkt); static uint16_t ectp_get_msg_type(const struct ectp_message *ectp_msg); static bool ectp_fwdaddr_ok(const uint8_t fwdaddr[ETH_ALEN]); static uint8_t *ectp_get_fwdaddr(const struct ectp_message *ectp_fwd_msg); static void ectp_inc_skipcount(struct ectp_packet *ectp_pkt); /* * */

*** global variables ***

static const unsigned char proto_name[] = "ectp"; static const unsigned char proto_banner[] __initconst = MOD_DESC; /* * ECTP Loopback Assistant multicast address */ static const uint8_t ectp_la_mcaddr[ETH_ALEN] = ECTP_LA_MCADDR; /* * Device notifier event handler structure */ static struct notifier_block ectp_notifblock = { .notifier_call = ectp_iface_notif_hdlr, };

/* * Packet type handler structure for ECTP type 0x9000 packets */ static struct packet_type ectp_packet_type = { .type = htons(ETH_P_ECTP), .dev = NULL, /* all interfaces */ .func = ectp_rcv, }; /* * Minimum jitter milliseconds to wait before sending a unicast * response to a broadcast or multicast (bmc) ECTP packet. */ static int ectp_bmc_rply_jttr_min_msecs __read_mostly = 10; /* * Minimum jitter milliseconds in ktime format */ static ktime_t ectp_bmc_rply_jttr_min_msecs_ktime __read_mostly; /* * Jitter random mask length, must match the initial * ectp_bmc_rply_jttr_randmask bit length below at compile time */ static unsigned int ectp_bmc_rply_jttr_randmask_len __read_mostly = 6; /* * Binary mask ANDed with net_rand() result to limit jitter value range. * Binary mask value must match bit count in ectp_bmc_rply_jttr_randmask_len at * compile time */ static uint32_t ectp_bmc_rply_jttr_randmask __read_mostly = 63; /* * Set unicast reply skb->priority to TC_PRIO_CONTROL or default of * TC_PRIO_BESTEFFORT? */ static int ectp_uc_rply_prio_ctrl __read_mostly = 0; /* * TC_PRIO value set in tx'd SKBs */ static uint32_t ectp_uc_rply_skb_prio __read_mostly = TC_PRIO_BESTEFFORT; /* * Maximum number of forward messages in a source routed packet. * Default value of zero means only permit replies back to the ECTP * originator */ static unsigned int ectp_src_rt_max_fwdmsgs __read_mostly = 0; /* * broadcast/multicast reply queue */ static struct ectp_reply_queue ectp_bmc_rply_q; /* * initial queue maximum length for bmc reply queues */

static const unsigned int ectp_init_bmc_q_maxlen __initconst = 10; /* * high res timer range accuracy nanoseconds */ static const unsigned long ectp_hrt_range_ns = 900000; /* * high res timer range accuracy nanoseconds in ktime_t */ static ktime_t ectp_hrt_range_ns_ktime __read_mostly; /* * Log bad forward messages? */ static unsigned int ectp_fwdmsg_log_bad __read_mostly = 0; /* * Log bad broadcast or multicast ECTP packets? */ static unsigned int ectp_bmc_log_bad __read_mostly = 0; /* * Prevent this station from responding to UC ECTP packets? */ static int ectp_uc_ignore __read_mostly = 0; /* * Prevent this station from responding to BMC ECTP packets? */ static int ectp_bmc_ignore __read_mostly = 0; #ifdef CONFIG_SYSCTL /* * /proc/sys/net/ectp entries */ static const int zero = 0; static const int one = 1; static const int ectp_bmc_rply_jttr_randmask_len_max = 10; static const int ectp_src_rt_max_fwdmsgs_max = 1000; /* should be plenty */ static const int ectp_bmc_rply_jttr_min_msecs_max = 1000; static const int ectp_bmc_q_maxlen_max = 30; static struct ctl_table ectp_table[] = { { .ctl_name = CTL_UNNUMBERED, .procname = "src_rt_max_fwdmsgs", .data = &ectp_src_rt_max_fwdmsgs, .maxlen = sizeof(unsigned int), .mode = 0644, .proc_handler = proc_dointvec_minmax, .strategy = sysctl_intvec, .extra1 = (void *)&zero, .extra2 = (void *)&ectp_src_rt_max_fwdmsgs_max

}, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data = CTL_UNNUMBERED, = "uc_rply_prio_ctrl", = &ectp_uc_rply_prio_ctrl, = = = = = = = = = CTL_UNNUMBERED, "uc_ignore", &ectp_uc_ignore, sizeof(int), 0644, proc_dointvec_minmax, sysctl_intvec, (void *)&zero, (void *)&one = = = = = = = = = CTL_UNNUMBERED, "bmc_ignore", &ectp_bmc_ignore, sizeof(int), 0644, proc_dointvec_minmax, sysctl_intvec, (void *)&zero, (void *)&one = = = = = = = = = CTL_UNNUMBERED, "bmc_rply_q_maxlen", &ectp_bmc_rply_q.skb_q.maxlen, sizeof(unsigned int), 0644, proc_dointvec_minmax, sysctl_intvec, (void *)&zero, (void *)&ectp_bmc_q_maxlen_max = = = = = = = = = CTL_UNNUMBERED, "bmc_jitter_randmask_len", &ectp_bmc_rply_jttr_randmask_len, sizeof(unsigned int), 0644, ectp_sysctl_bmc_rply_jttr_randmask_len, sysctl_intvec, (void *)&zero, (void *)&ectp_bmc_rply_jttr_randmask_len_max = = = = = = = = = CTL_UNNUMBERED, "bmc_jitter_min_msecs", &ectp_bmc_rply_jttr_min_msecs, sizeof(int), 0644, ectp_sysctl_bmc_rply_jttr_min_msecs, sysctl_intvec, (void *)&zero, (void *)&ectp_bmc_rply_jttr_min_msecs_max

.maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { .ctl_name .procname .data .maxlen .mode .proc_handler .strategy .extra1 .extra2 }, { 0 }, };

= = = = = = = = = = = = = = = = = = = = = = = =

sizeof(int), 0644, ectp_sysctl_uc_prio_ctrl, sysctl_intvec, (void *)&zero, (void *)&one CTL_UNNUMBERED, "fwdmsg_log_bad", &ectp_fwdmsg_log_bad, sizeof(unsigned int), 0644, proc_dointvec_minmax, sysctl_intvec, (void *)&zero, (void *)&one CTL_UNNUMBERED, "bmc_log_bad", &ectp_bmc_log_bad, sizeof(unsigned int), 0644, proc_dointvec_minmax, sysctl_intvec, (void *)&zero, (void *)&one

/* * /proc/sys/net/ectp */ static struct ctl_path ectp_path[] = { { .procname = "net", .ctl_name = CTL_NET, }, { .procname = "ectp", .ctl_name = CTL_UNNUMBERED, }, { } }; static struct ctl_table_header *ectp_table_header; #endif /* CONFIG_SYSCTL */ /* * */

*** functions ***

/* * module initialisation */ /* * main ectp_init() routine at the end of the file */ /* * ectp_init_ktimes()

* * Initialise a few ktime values used by the module */ static void __init ectp_init_ktimes(void) { ectp_bmc_rply_jttr_min_msecs_ktime = ectp_ms_to_ktime(ectp_bmc_rply_jttr_min_msecs); ectp_hrt_range_ns_ktime = ns_to_ktime(ectp_hrt_range_ns); } /* * ectp_setup_bmc_rply_q() * * Sets up the broadcast/multicast reply queue */ static void __init ectp_setup_bmc_rply_q(void) { ectp_init_skb_q(&ectp_bmc_rply_q.skb_q, ectp_init_bmc_q_maxlen); ectp_setup_rply_q_hrt(&ectp_bmc_rply_q, ectp_bmc_sched_tasklet); tasklet_init(&ectp_bmc_rply_q.q_tasklet, ectp_bmc_tx_skb, 0); } /* * ectp_init_skb_q() * * Initialise skb queue parameters */ static void __init ectp_init_skb_q(struct ectp_skb_queue *skb_q, const unsigned int q_maxlen) { skb_queue_head_init(&skb_q->head); skb_q->maxlen = q_maxlen; spin_lock_init(&skb_q->spinlock); } /* * ectp_setup_rply_q_hrt() * * setup high res timer parameters for a reply queue */ static void __init ectp_setup_rply_q_hrt(struct ectp_reply_queue *rply_q, enum hrtimer_restart (*kernt_func) (struct hrtimer *))

{ hrtimer_init(&rply_q->q_hrt_kernt, CLOCK_REALTIME, HRTIMER_MODE_ABS); rply_q->q_hrt_kernt.function = kernt_func; } /* * ectp_setup_ifaces() * * Setup ethernet interfaces to receive ECTP loopback assist multicasts. */ static void __init ectp_setup_ifaces(void) { ectp_register_ifaces_notif(); } /* * ectp_register_ifaces_notif() * * Register new interface notifier. Notifier called automatically on * registration. */ static void __init ectp_register_ifaces_notif(void) { register_netdevice_notifier(&ectp_notifblock); } /* * ectp_register_packet_hdlr() * * Register ECTP rx packet handler function */ static void __init ectp_register_packet_hdlr(void) { dev_add_pack(&ectp_packet_type); } /* * ectp_register_sysctl() * * Register sysctl, which includes creating files under /proc/sys/net/ectp */ static void __init ectp_register_sysctl(void) {

#ifdef CONFIG_SYSCTL ectp_table_header = register_sysctl_paths(ectp_path, ectp_table); #endif } /* * ectp_print_banner() * * Print protocol name and version banner */ static void __init ectp_print_banner(void) { pr_info("%s: %s\n", proto_name, proto_banner); } /* * module exit */ /* * ectp_exit() routine at end of file */ /* * ectp_unregister_sysctl() * * Remove sysctls, which also includes removing /proc/sys/net/ectp directory */ static void __exit ectp_unregister_sysctl(void) { #ifdef CONFIG_SYSCTL unregister_sysctl_table(ectp_table_header); #endif } /* * ectp_unregister_packet_hdlr() * * Deregister ECTP rx packet handler */ static void __exit ectp_unregister_packet_hdlr(void) { dev_remove_pack(&ectp_packet_type); }

/* * ectp_reset_ifaces() * * Remove ECTP loopback assist multicast addr from ethernet interfaces, * and remove ECTP notifier */ static void __exit ectp_reset_ifaces(void) { ectp_unregister_ifaces_notif(); ectp_allifaces_del_la_mcaddr(); } /* * ectp_unregister_ifaces_notif() * * Remove new interface notifier. */ static void __exit ectp_unregister_ifaces_notif(void) { unregister_netdevice_notifier(&ectp_notifblock); } /* * ectp_allifaces_del_la_mcaddr() * * Remove ectp loopback assist multicast address from all existing * interfaces. */ static void __exit ectp_allifaces_del_la_mcaddr(void) { struct net_device *netdev; rtnl_lock(); for_each_netdev(&init_net, netdev) { if (netdev->type == ARPHRD_ETHER) ectp_netdev_del_la_mcaddr(netdev); } rtnl_unlock(); } /* * ectp_shutdown_bmc_rply_q() * * shutdown / clean up the bmc reply queue

* * n.b. ectp related notifiers / softirqs are assumed to have been disabled * / shutdown, so reply queue locking isn't needed after kernel timer stopped */ static void __exit ectp_shutdown_bmc_rply_q(void) { ectp_rply_q_kernt_stop(&ectp_bmc_rply_q); tasklet_disable(&ectp_bmc_rply_q.q_tasklet); if (!skb_queue_empty(&ectp_bmc_rply_q.skb_q.head)) skb_queue_purge(&ectp_bmc_rply_q.skb_q.head); } /* * ectp_allifaces_netdev_put() * * Release net_device refcount for all ECTP interfaces */ static void __exit ectp_allifaces_netdev_put(void) { struct net_device *netdev; rtnl_lock(); for_each_netdev(&init_net, netdev) { if (netdev->type == ARPHRD_ETHER) dev_put(netdev); } rtnl_unlock(); } /* * interface notifier and related */ /* * ectp_netdev_add_la_mcaddr() * * Add the ECTP loopback assist multicast address to the specified device. */ static void ectp_netdev_add_la_mcaddr(struct net_device *netdev) { dev_mc_add(netdev, (void *)ectp_la_mcaddr, ETH_ALEN, 0); } /* * ectp_netdev_del_la_mcaddr()

* * Remove the ECTP loopback assist multicast address from the specified * device. */ static void ectp_netdev_del_la_mcaddr(struct net_device *netdev) { dev_mc_delete(netdev, (void *)ectp_la_mcaddr, ETH_ALEN, 0); } /* * ectp_iface_notif_hdlr() * * Interface notifier event handler. */ static int ectp_iface_notif_hdlr(struct notifier_block *nb, unsigned long event, void *ptr) { struct net_device *netdev = (struct net_device *)ptr; if (netdev->type != ARPHRD_ETHER) return NOTIFY_DONE; switch (event) { case NETDEV_REGISTER: dev_hold(netdev); ectp_netdev_add_la_mcaddr(netdev); break; case NETDEV_DOWN: ectp_rply_q_purge_skb_netdev(&ectp_bmc_rply_q, netdev); break; case NETDEV_UNREGISTER: ectp_netdev_del_la_mcaddr(netdev); dev_put(netdev); break; default: return NOTIFY_DONE; } return NOTIFY_OK; } /* * ectp_rply_q_purge_skb_netdev() * * Purge skbs off of reply queue that would be tx'd out specified net device * */ static void ectp_rply_q_purge_skb_netdev(struct ectp_reply_queue *rply_q, const struct net_device *netdev) { struct sk_buff_head skb_purge_q; struct sk_buff *head_skb;

struct sk_buff *tmp_skb;

spin_lock_bh(&rply_q->skb_q.spinlock); if (skb_queue_empty(&rply_q->skb_q.head)) { spin_unlock_bh(&rply_q->skb_q.spinlock); return; } head_skb = skb_peek(&rply_q->skb_q.head); skb_queue_head_init(&skb_purge_q); ectp__move_netdev_skbs(&rply_q->skb_q.head, &skb_purge_q, netdev); if (unlikely(!skb_queue_empty(&rply_q->skb_q.head))) { tmp_skb = skb_peek(&rply_q->skb_q.head); if (head_skb != tmp_skb) ectp_rply_q_kernt_try_resched(rply_q, tmp_skb->tstamp); } else { ectp_rply_q_kernt_try_stop(rply_q); } spin_unlock_bh(&rply_q->skb_q.spinlock); if (!skb_queue_empty(&skb_purge_q)) skb_queue_purge(&skb_purge_q); } /* * ectp__move_netdev_skbs() * * Move skbs on from_skb_q to to_skb_q with matching net_device * * n.b. caller must be holding appropriate locks on the queues */ static void ectp__move_netdev_skbs(struct sk_buff_head *from_skb_q, struct sk_buff_head *to_skb_q, const struct net_device *netdev) { struct sk_buff *skb; struct sk_buff *tmp_skb; skb_queue_walk_safe(from_skb_q, skb, tmp_skb) { if (skb->dev == netdev) { skb_unlink(skb, from_skb_q); skb_queue_tail(to_skb_q, skb); } } } /* * incoming packet handling

*/ /* * ectp_rcv() * * ECTP incoming packet handler * */ static int ectp_rcv(struct sk_buff *skb, struct net_device *netdev, struct packet_type *pt, struct net_device *orig_netdev) { const unsigned int pkt_type = skb->pkt_type; if (netdev->type != ARPHRD_ETHER) goto drop; switch (pkt_type) { case PACKET_HOST: if (ectp_uc_ignore) goto drop; break; case PACKET_MULTICAST: if (ectp_bmc_ignore) goto drop; if (!ectp_la_mcaddr_dst_ok(skb)) goto drop; break; case PACKET_BROADCAST: if (ectp_bmc_ignore) goto drop; break; default: goto drop; break; } if (likely(!skb_is_nonlinear(skb))) { if (!ectp_linear_skb_ok(skb, netdev->name, pkt_type)) goto drop; } else { switch (ectp_nonlinear_skb_ok(&skb, netdev->name, pkt_type)) { case ECTP_NONL_SKB_OK: break; case ECTP_NONL_SKB_DROP: goto drop; break; case ECTP_NONL_SKB_BAD: goto bad; break; default: goto drop; break; }; } if (likely(ectp_send_frame_ok(pkt_type, skb))) return NET_RX_SUCCESS;

else return NET_RX_BAD; drop: kfree_skb(skb); return NET_RX_DROP; bad: return NET_RX_BAD; } /* ectp_rcv() */ /* * ectp_la_mcaddr_dst_ok() * * checks if dest mac address of supplied skb is the ECTP loopback assist * multicast address */ static bool ectp_la_mcaddr_dst_ok(const struct sk_buff *skb) { const struct ethhdr *ehdr = (struct ethhdr *)skb_mac_header(skb); if (likely(compare_ether_addr(ehdr->h_dest, ectp_la_mcaddr) == 0)) return true; else return false; } /* * ectp_linear_skb_ok() * * Perform validation checks on linear skbs. */ static bool ectp_linear_skb_ok(const struct sk_buff *skb, const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int pkt_type) { const unsigned int pkt_len = skb->len; const struct ectp_packet *ectp_pkt; unsigned int skipcount; const unsigned int msgs_len = pkt_len - ECTP_SKIPCOUNT_HDR_SZ; const struct ectp_message *curr_msg; const struct ethhdr *ectp_ethhdr; const uint8_t *curr_msg_fwdaddr; if (pkt_len <= ECTP_SKIPCOUNT_HDR_SZ) goto drop; ectp_pkt = (struct ectp_packet *)skb_network_header(skb); skipcount = ectp_get_skipcount(ectp_pkt); if (!ectp_skipcount_valid(skipcount, msgs_len)) goto drop; curr_msg = ectp_get_msg_ptr(skipcount, ectp_pkt);

if (ectp_get_msg_type(curr_msg) != ECTP_FWDMSG) goto drop; if (!ectp_full_fwdmsg_avail(msgs_len, skipcount)) goto drop; ectp_ethhdr = eth_hdr(skb); curr_msg_fwdaddr = ectp_get_fwdaddr(curr_msg); if (!ectp_fwdmsg_chk_ok(rx_netdev_name, pkt_type, ectp_ethhdr->h_source, skipcount, curr_msg_fwdaddr)) goto drop; /* * If it's a broadcast or multicast forward message, ensure the * next message in the packet is not a forward message as per * "8.4.2.1 Restrictions on Forward Data Messages" in spec. */ if (pkt_type != PACKET_HOST) { if (!ectp_next_msgtype_avail(skipcount, msgs_len)) goto drop; if (!ectp_bmc_nextmsg_chk_ok(ectp_pkt, skipcount, pkt_type, ectp_ethhdr->h_source, rx_netdev_name)) goto drop; } return true; drop: return false; } /* ectp_linear_skb_ok() */ /* * ectp_skipcount_valid() * * Check if the skipcount value in the specified packet is ok to use to refer * to a message */ static bool ectp_skipcount_valid(const unsigned int skipcount, const unsigned int msgs_len) { if (likely(skipcount == 0)) { if (unlikely(msgs_len < ECTP_MSG_HDR_SZ)) return false; else return true; } else { if (ectp_src_rt_max_fwdmsgs == 0) return false;

BUILD_BUG_ON((ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ) != 8); if ((skipcount & ((ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ)-1)) != 0) return false; if (ectp_skipc_to_num_fwdmsgs(skipcount) > ectp_src_rt_max_fwdmsgs) return false; if (skipcount > (msgs_len - ECTP_MSG_HDR_SZ)) return false; return true; } } /* * ectp_skipc_to_num_fwdmsgs() * * Return number of forward messages represented by the supplied skipcount */ static unsigned int ectp_skipc_to_num_fwdmsgs(const unsigned int skipcount) { return (skipcount >> 3) + 1; } /* * ectp_full_fwdmsg_avail() * * Check if room within specified messages length for a full forward message */ static bool ectp_full_fwdmsg_avail(const unsigned int msgs_len, const unsigned int skipcount) { if (likely((msgs_len - skipcount) >= (ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ))) return true; else return false; } /* * ectp_fwdmsg_chk_ok() * * performs various validation checks on the forward message attributes */ static bool ectp_fwdmsg_chk_ok(const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int rxed_pkt_type,

const uint8_t srcmac[ETH_ALEN], const unsigned int skipcount, const uint8_t fwdaddr[ETH_ALEN]) { if (!ectp_fwdaddr_chk_ok(fwdaddr, skipcount, srcmac, rx_netdev_name)) return false; if (!ectp_srcmac_rpf_chk_ok(srcmac, fwdaddr)) return false; return true; } /* * ectp_fwdaddr_chk_ok() * * checks the supplied forward address is valid, optionally logs a message * if not */ static bool ectp_fwdaddr_chk_ok(const uint8_t fwdaddr[ETH_ALEN], const unsigned int skipcount, const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]) { if (unlikely(!ectp_fwdaddr_ok(fwdaddr))) { if (ectp_fwdmsg_log_bad) ectp_log_bad_fwdmsg(skipcount, fwdaddr, srcmac, rx_netdev_name); return false; } else { return true; } } /* * ectp_log_bad_fwdmsg() * * Log a kernel message about a bad forward message, but only if * skipcount == 0, which means we've caught the originator source * mac address */ static void ectp_log_bad_fwdmsg(const unsigned int skipcount, const uint8_t bad_fwdaddr[ETH_ALEN], const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]) { if ((skipcount == 0) && net_ratelimit()) pr_warning("%s: Bad forward addr %pM from %pM, rcvd on %s\n",

proto_name, bad_fwdaddr, srcmac, rx_netdev_name); } /* * ectp_srcmac_rpf_chk_ok() * * perform a srcmac / forward address reverse path forwarding check if * source routed ECTP packets aren't allowed */ static bool ectp_srcmac_rpf_chk_ok(const uint8_t srcmac[ETH_ALEN], const uint8_t fwdaddr[ETH_ALEN]) { if (likely(ectp_src_rt_max_fwdmsgs == 0)) { if (unlikely(!ectp_srcmac_fwdaddr_match(srcmac, fwdaddr))) return false; else return true; } else { return true; } } /* * ectp_srcmac_fwdaddr_match() * * checks if supplied ECTP packet source mac address matches supplied * forward address */ static bool ectp_srcmac_fwdaddr_match(const uint8_t srcmac[ETH_ALEN], const uint8_t fwdaddr[ETH_ALEN]) { if (unlikely(compare_ether_addr((u8 *)srcmac, (u8 *)fwdaddr) != 0)) return false; else return true; } /* * ectp_next_msgtype_avail() * * Check if next message type available after the current one pointed to by * supplied skipcount */ static bool ectp_next_msgtype_avail(const unsigned int skipcount, const unsigned int msgs_len) { if (likely((skipcount + ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ) <= (msgs_len - ECTP_MSG_HDR_SZ)))

return true; else return false; } /* * ectp_bmc_nextmsg_chk_ok() * * Check if bmc packet next message is a forward message, log a warning if * necessary */ static bool ectp_bmc_nextmsg_chk_ok(const struct ectp_packet *ectp_pkt, const unsigned int skipcount, const unsigned int rxed_pkt_type, const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]) { struct ectp_message *ectp_next_msg = ectp_get_msg_ptr(skipcount + ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ, ectp_pkt); if (unlikely(ectp_get_msg_type(ectp_next_msg) == ECTP_FWDMSG)) { if (ectp_bmc_log_bad) { ectp_log_bad_bmc(rxed_pkt_type, srcmac, rx_netdev_name); } return false; } else { return true; } } /* * ectp_log_bad_bmc() * * Log a kernel message about receiving a bad broadcast/multicast message */ static void ectp_log_bad_bmc(const unsigned int rxed_pkt_type, const uint8_t srcmac[ETH_ALEN], const unsigned char rx_netdev_name[IFNAMSIZ]) { if (net_ratelimit()) { const unsigned char *pkt_type_text; switch (rxed_pkt_type) { case PACKET_MULTICAST: pkt_type_text = "multicast"; break; case PACKET_BROADCAST: pkt_type_text = "broadcast"; break;

default: pkt_type_text = "unknown"; } pr_warning("%s: Bad %s packet, > 1 fwd msg, from %pM, " "rcvd on %s\n", proto_name, pkt_type_text, srcmac, rx_netdev_name); } } /* * ectp_nonlinear_skb_ok() * * Perform validation checks on non-linear skbs. */ static enum ectp_nonl_skb_ok ectp_nonlinear_skb_ok(struct sk_buff **skb_p, const unsigned char rx_netdev_name[IFNAMSIZ], const unsigned int pkt_type) { const unsigned int pkt_len = (*skb_p)->len; unsigned int skb_pull_len; struct ectp_packet *ectp_pkt; unsigned int skipcount; const unsigned int msgs_len = pkt_len - ECTP_SKIPCOUNT_HDR_SZ; struct ectp_message *curr_msg; struct ethhdr *ectp_ethhdr; const uint8_t *curr_msg_fwdaddr; if (pkt_len <= ECTP_SKIPCOUNT_HDR_SZ) goto drop; if (!ectp_private_skb_ok(skb_p)) goto bad; skb_pull_len = ECTP_SKIPCOUNT_HDR_SZ; if (!ectp_pskb_pull_ok(*skb_p, ECTP_SKIPCOUNT_HDR_SZ, NULL, NULL, NULL)) goto drop; ectp_pkt = (struct ectp_packet *)skb_network_header(*skb_p); skipcount = ectp_get_skipcount(ectp_pkt); if (!ectp_skipcount_valid(skipcount, msgs_len)) goto drop; skb_pull_len += skipcount + ECTP_MSG_HDR_SZ; if (skb_pull_len >= pkt_len) goto drop; if (!ectp_pskb_pull_ok(*skb_p, skb_pull_len, &ectp_pkt, NULL, NULL)) goto drop; curr_msg = ectp_get_msg_ptr(skipcount, ectp_pkt); if (ectp_get_msg_type(curr_msg) != ECTP_FWDMSG)

goto drop; if (!ectp_full_fwdmsg_avail(msgs_len, skipcount)) goto drop; skb_pull_len += ECTP_MSG_HDR_SZ + ECTP_FWDMSG_SZ; if (skb_pull_len >= pkt_len) goto drop; if (!ectp_pskb_pull_ok(*skb_p, skb_pull_len, &ectp_pkt, &curr_msg, NULL)) goto drop; ectp_ethhdr = eth_hdr(*skb_p); curr_msg_fwdaddr = ectp_get_fwdaddr(curr_msg); if (!ectp_fwdmsg_chk_ok(rx_netdev_name, pkt_type, ectp_ethhdr->h_source, skipcount, curr_msg_fwdaddr)) goto drop; /* * If it's a broadcast or multicast forward message, ensure the * next message in the packet is not a forward message as per * "8.4.2.1 Restrictions on Forward Data Messages" in spec. */ if (pkt_type != PACKET_HOST) { if (!ectp_next_msgtype_avail(skipcount, msgs_len)) goto drop; skb_pull_len += ECTP_MSG_HDR_SZ; if (skb_pull_len >= pkt_len) goto drop; if (!ectp_pskb_pull_ok(*skb_p, skb_pull_len, &ectp_pkt, &curr_msg, &ectp_ethhdr)) goto drop; if (!ectp_bmc_nextmsg_chk_ok(ectp_pkt, skipcount, pkt_type, ectp_ethhdr->h_source, rx_netdev_name)) goto drop; } if (!ectp_pskb_pull_ok(*skb_p, pkt_len, NULL, NULL, NULL)) goto drop; return ECTP_NONL_SKB_OK; drop: return ECTP_NONL_SKB_DROP; bad: return ECTP_NONL_SKB_BAD; } /* ectp_nonlinear_skb_ok() */

/* * ectp_private_skb_ok() * * Check if skb shared, if so, copy it, because we're probably going * to modify it */ static bool ectp_private_skb_ok(struct sk_buff **skb_p) { *skb_p = skb_share_check(*skb_p, GFP_ATOMIC); if (likely(*skb_p != NULL)) return true; else return false; } /* * ectp_pskb_pull_ok() * * Pull specified bytes into main data buffer if necessary, * and then update effected pointers if required */ static bool ectp_pskb_pull_ok(struct sk_buff *skb, const unsigned int pull_len, struct ectp_packet **ectp_pkt_p, struct ectp_message **ectp_curr_msg_p, struct ethhdr **ectp_ethhdr_p) { if (likely(pskb_may_pull(skb, pull_len))) { if (ectp_pkt_p != NULL) { *ectp_pkt_p = (struct ectp_packet *)skb_network_header(skb); if (ectp_curr_msg_p != NULL) *ectp_curr_msg_p = ectp_get_curr_msg_ptr(*ectp_pkt_p); } if (ectp_ethhdr_p != NULL) *ectp_ethhdr_p = eth_hdr(skb); return true; } else { return false; } } /* * building and sending outgoing packets */

/* * ectp_send_frame_ok() * * Send off the supplied ECTP packet, by building a new skb * and then transmitting it if it is response to a unicast, or queuing it * if it is a response to a broadcast or multicast. */ static bool ectp_send_frame_ok(const int rxed_pkt_type, struct sk_buff *rx_skb) { struct sk_buff *tx_skb