3 # Copyright (c) 2021 Cisco and/or its affiliates.
5 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
7 # Licensed under the Apache License 2.0 or
8 # GNU General Public License v2.0 or later; you may not use this file
9 # except in compliance with one of these Licenses. You
10 # may obtain a copy of the Licenses at:
12 # http://www.apache.org/licenses/LICENSE-2.0
13 # https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
15 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
16 # must be under GPLv2+. If at any point in the future it is no longer linked
17 # with Scapy (or other GPLv2+ licensed software), you are free to choose
20 # Unless required by applicable law or agreed to in writing, software
21 # distributed under the License is distributed on an "AS IS" BASIS,
22 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 # See the License for the specific language governing permissions and
24 # limitations under the License.
26 """Traffic script that sends an IP ICMPv4 or ICMPv6."""
31 from scapy.layers.inet import ICMP, IP
32 from scapy.layers.inet6 import ICMPv6EchoRequest, ICMPv6EchoReply,\
33 ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
34 from scapy.layers.l2 import Ether
35 from scapy.packet import Raw
37 from .PacketVerifier import RxQueue, TxQueue
38 from .TrafficScriptArg import TrafficScriptArg
41 def valid_ipv4(ip_address):
42 """Check IPv4 address.
44 :param ip_address: IPv4 address to check.
46 :returns: True if IP address is correct.
50 ipaddress.IPv4Address(ip_address)
52 except (AttributeError, ipaddress.AddressValueError):
56 def valid_ipv6(ip_address):
57 """Check IPv6 address.
59 :param ip_address: IPv6 address to check.
61 :returns: True if IP address is correct.
65 ipaddress.IPv6Address(ip_address)
67 except (AttributeError, ipaddress.AddressValueError):
72 """Send ICMP echo request and wait for ICMP echo reply. It ignores all other
74 args = TrafficScriptArg(
75 [u"dst_mac", u"src_mac", u"dst_ip", u"src_ip", u"timeout"]
78 dst_mac = args.get_arg(u"dst_mac")
79 src_mac = args.get_arg(u"src_mac")
80 dst_ip = args.get_arg(u"dst_ip")
81 src_ip = args.get_arg(u"src_ip")
82 tx_if = args.get_arg(u"tx_if")
83 rx_if = args.get_arg(u"rx_if")
84 timeout = int(args.get_arg(u"timeout"))
91 # Create empty ip ICMP packet
92 if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
96 icmp_type = 0 # echo-reply
97 elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
99 icmp_req = ICMPv6EchoRequest
100 icmp_resp = ICMPv6EchoReply
101 icmp_type = 0 # Echo Reply
103 raise ValueError(u"IP not in correct format")
106 Ether(src=src_mac, dst=dst_mac) /
107 ip_layer(src=src_ip, dst=dst_ip) /
111 # Send created packet on the interface
112 icmp_request /= Raw()
113 sent_packets.append(icmp_request)
114 txq.send(icmp_request)
116 for _ in range(1000):
118 icmp_reply = rxq.recv(wait_step, ignore=sent_packets)
119 if icmp_reply is None:
122 raise RuntimeError(u"ICMP echo Rx timeout")
124 elif icmp_reply.haslayer(ICMPv6ND_NS):
125 # read another packet in the queue in case of ICMPv6ND_NS packet
127 elif icmp_reply.haslayer(ICMPv6MLReport2):
128 # read another packet in the queue if the current one is
131 elif icmp_reply.haslayer(ICMPv6ND_RA):
132 # read another packet in the queue if the current one is
138 if icmp_reply[ip_layer][icmp_resp].type == icmp_type:
139 if icmp_reply[ip_layer].src == dst_ip and \
140 icmp_reply[ip_layer].dst == src_ip:
143 raise RuntimeError(u"Max packet count limit reached")
145 print(u"ICMP echo reply received.")
150 if __name__ == u"__main__":