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 ICMP/ICMPv6 packet out one interface, receives
27 a LISP-encapsulated packet on the other interface and verifies received packet.
33 from scapy.all import bind_layers, Packet
34 from scapy.fields import FlagsField, BitField, IntField
35 from scapy.layers.inet import ICMP, IP, UDP
36 from scapy.layers.inet6 import ICMPv6EchoRequest
37 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2
38 from scapy.layers.l2 import Ether
39 from scapy.packet import Raw
41 from ..PacketVerifier import RxQueue, TxQueue
42 from ..TrafficScriptArg import TrafficScriptArg
45 class LispHeader(Packet):
46 """Scapy header for the LISP Layer."""
51 u"flags", None, 8, [u"N", u"L", u"E", u"V", u"I", u"", u"", u""]
53 BitField(u"nonce/map_version", 0, size=24),
54 IntField(u"instance_id/locator_status_bits", 0)]
57 class LispInnerIP(IP):
58 """Scapy inner LISP layer for IPv4-in-IPv4."""
60 name = u"Lisp Inner Layer - IPv4"
63 class LispInnerIPv6(IPv6):
64 """Scapy inner LISP layer for IPv6-in-IPv6."""
66 name = u"Lisp Inner Layer - IPv6"
69 def valid_ipv4(ip_address):
70 """Check IPv4 address.
72 :param ip_address: IPv4 address to check.
74 :returns: True if IP address is correct.
76 :raises AttributeError, AddressValueError: If IP address is not valid.
79 ipaddress.IPv4Address(ip_address)
81 except (AttributeError, ipaddress.AddressValueError):
85 def valid_ipv6(ip_address):
86 """Check IPv6 address.
88 :param ip_address: IPv6 address to check.
90 :returns: True if IP address is correct.
92 :raises AttributeError, AddressValueError: If IP address is not valid.
95 ipaddress.IPv6Address(ip_address)
97 except (AttributeError, ipaddress.AddressValueError):
102 """Send IP ICMP packet from one traffic generator interface to the other.
104 :raises RuntimeError: If the received packet is not correct.
107 args = TrafficScriptArg(
109 u"tg_src_mac", u"tg_dst_mac", u"src_ip", u"dst_ip", u"dut_if1_mac",
110 u"dut_if2_mac", u"src_rloc", u"dst_rloc"
115 tx_src_mac = args.get_arg(u"tg_src_mac")
116 tx_dst_mac = args.get_arg(u"dut_if1_mac")
117 rx_dst_mac = args.get_arg(u"tg_dst_mac")
118 rx_src_mac = args.get_arg(u"dut_if2_mac")
119 src_ip = args.get_arg(u"src_ip")
120 dst_ip = args.get_arg(u"dst_ip")
121 src_rloc = args.get_arg(u"src_rloc")
122 dst_rloc = args.get_arg(u"dst_rloc")
123 tx_if = args.get_arg(u"tx_if")
124 rx_if = args.get_arg(u"rx_if")
125 ot_mode = args.get_arg(u"ot_mode")
130 pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
132 if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
133 pkt_raw /= IP(src=src_ip, dst=dst_ip)
136 lisp_layer = LispInnerIP
137 elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
138 pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
139 pkt_raw /= ICMPv6EchoRequest()
141 lisp_layer = LispInnerIPv6
143 raise ValueError(u"IP not in correct format")
145 bind_layers(UDP, LispHeader, dport=4341)
146 bind_layers(LispHeader, lisp_layer)
149 sent_packets = list()
150 sent_packets.append(pkt_raw)
155 ether = rxq.recv(2, ignore=sent_packets)
160 raise RuntimeError(u"ICMP echo Rx timeout")
162 if ether.haslayer(ICMPv6ND_NS):
163 # read another packet in the queue if the current one is ICMPv6ND_NS
165 elif ether.haslayer(ICMPv6MLReport2):
166 # read another packet in the queue if the current one is
170 # otherwise process the current packet
173 if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
174 print(u"MAC addresses match.")
176 raise RuntimeError(f"Matching packet unsuccessful: {ether!r}")
180 if ot_mode == u"6to4":
181 if not isinstance(ip, IP):
182 raise RuntimeError(f"Not an IP packet received {ip!r}")
183 elif ot_mode == u"4to6":
184 if not isinstance(ip, IPv6):
185 raise RuntimeError(f"Not an IP packet received {ip!r}")
186 elif not isinstance(ip, ip_format):
187 raise RuntimeError(f"Not an IP packet received {ip!r}")
189 lisp = ether.getlayer(lisp_layer)
191 raise RuntimeError("Lisp layer not present or parsing failed.")
193 # Compare data from packets
194 if src_ip == lisp.src:
195 print(u"Source IP matches source EID.")
198 f"Matching Src IP unsuccessful: {src_ip} != {lisp.src}"
201 if dst_ip == lisp.dst:
202 print(u"Destination IP matches destination EID.")
205 f"Matching Dst IP unsuccessful: {dst_ip} != {lisp.dst}"
208 if src_rloc == ip.src:
209 print(u"Source RLOC matches configuration.")
212 f"Matching Src RLOC unsuccessful: {src_rloc} != {ip.src}"
215 if dst_rloc == ip.dst:
216 print(u"Destination RLOC matches configuration.")
219 f"Matching dst RLOC unsuccessful: {dst_rloc} != {ip.dst}"
225 if __name__ == u"__main__":