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 IPv4/IPv6 packet from one interface
27 to the other. Source and destination IP addresses and source and destination
28 MAC addresses are checked in received packet.
33 from robot.api import logger
34 from scapy.layers.inet import IP
35 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
36 from scapy.layers.l2 import Ether, Dot1Q
37 from scapy.packet import Raw
39 from .PacketVerifier import RxQueue, TxQueue
40 from .TrafficScriptArg import TrafficScriptArg
41 from .ValidIp import valid_ipv4, valid_ipv6
44 """Send IP/IPv6 packet from one traffic generator interface to the other."""
45 args = TrafficScriptArg(
47 u"tg_src_mac", u"tg_dst_mac", u"src_ip", u"dst_ip", u"dut_if1_mac",
51 u"encaps_tx", u"vlan_tx", u"vlan_outer_tx", u"encaps_rx",
52 u"vlan_rx", u"vlan_outer_rx"
56 tx_src_mac = args.get_arg(u"tg_src_mac")
57 tx_dst_mac = args.get_arg(u"dut_if1_mac")
58 rx_dst_mac = args.get_arg(u"tg_dst_mac")
59 rx_src_mac = args.get_arg(u"dut_if2_mac")
60 src_ip = args.get_arg(u"src_ip")
61 dst_ip = args.get_arg(u"dst_ip")
62 tx_if = args.get_arg(u"tx_if")
63 rx_if = args.get_arg(u"rx_if")
65 encaps_tx = args.get_arg(u"encaps_tx")
66 vlan_tx = args.get_arg(u"vlan_tx")
67 vlan_outer_tx = args.get_arg(u"vlan_outer_tx")
68 encaps_rx = args.get_arg(u"encaps_rx")
69 vlan_rx = args.get_arg(u"vlan_rx")
70 vlan_outer_rx = args.get_arg(u"vlan_outer_rx")
76 pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
78 if encaps_tx == u"Dot1q":
79 pkt_raw /= Dot1Q(vlan=int(vlan_tx))
80 elif encaps_tx == u"Dot1ad":
82 pkt_raw /= Dot1Q(vlan=vlan_outer_tx)
83 pkt_raw /= Dot1Q(vlan=vlan_tx)
85 if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
86 pkt_raw /= IP(src=src_ip, dst=dst_ip, proto=61)
88 elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
89 pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
92 raise ValueError(u"IP not in correct format")
95 sent_packets.append(pkt_raw)
100 ether = rxq.recv(2, ignore=sent_packets)
105 raise RuntimeError(u"IP packet Rx timeout")
107 if ether.haslayer(ICMPv6ND_NS):
108 # read another packet in the queue if the current one is ICMPv6ND_NS
110 elif ether.haslayer(ICMPv6MLReport2):
111 # read another packet in the queue if the current one is
114 elif ether.haslayer(ICMPv6ND_RA):
115 # read another packet in the queue if the current one is
121 if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
122 logger.trace(u"MAC matched")
124 raise RuntimeError(f"Matching packet unsuccessful: {ether!r}")
126 if encaps_rx == u"Dot1q":
127 if ether[Dot1Q].vlan == int(vlan_rx):
128 logger.trace(u"VLAN matched")
131 f"Ethernet frame with wrong VLAN tag "
132 f"({ether[Dot1Q].vlan}-received, "
133 f"{vlan_rx}-expected):\n{ether!r}"
135 ip = ether[Dot1Q].payload
136 elif encaps_rx == u"Dot1ad":
137 raise NotImplementedError()
141 if not isinstance(ip, ip_format):
142 raise RuntimeError(f"Not an IP packet received {ip!r}")
144 # Compare data from packets
146 logger.trace(u"Src IP matched")
149 f"Matching Src IP unsuccessful: {src_ip} != {ip.src}"
153 logger.trace(u"Dst IP matched")
156 f"Matching Dst IP unsuccessful: {dst_ip} != {ip.dst}"
162 if __name__ == u"__main__":