GPL/traffic_scripts/lisp/lispgpe_check.py

   1 #!/usr/bin/env python3
   2
   3 # Copyright (c) 2021 Cisco and/or its affiliates.
   4 #
   5 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
   6 #
   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:
  11 #
  12 #     http://www.apache.org/licenses/LICENSE-2.0
  13 #     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
  14 #
  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
  18 # Apache 2.
  19 #
  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.
  25
  26 """Traffic script that sends an ICMP/ICMPv6 packet out one interface, receives
  27 a LISPGPE-encapsulated packet on the other interface and verifies received
  28 packet.
  29 """
  30
  31 import sys
  32 import ipaddress
  33
  34 from scapy.all import bind_layers, Packet
  35 from scapy.fields import FlagsField, BitField, XBitField, IntField
  36 from scapy.layers.inet import ICMP, IP, UDP
  37 from scapy.layers.inet6 import ICMPv6EchoRequest
  38 from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
  39 from scapy.layers.l2 import Ether
  40 from scapy.packet import Raw
  41
  42 from ..PacketVerifier import RxQueue, TxQueue
  43 from ..TrafficScriptArg import TrafficScriptArg
  44
  45
  46 class LispGPEHeader(Packet):
  47     """Scapy header for the Lisp GPE Layer."""
  48
  49     name = "Lisp GPE Header"
  50     fields_desc = [
  51         FlagsField(
  52             u"flags", None, 8, [u"N", u"L", u"E", u"V", u"I", u"P", u"R", u"O"]
  53         ),
  54         BitField(u"version", 0, size=2),
  55         BitField(u"reserved", 0, size=14),
  56         XBitField(u"next_protocol", 0, size=8),
  57         IntField(u"instance_id/locator_status_bits", 0)
  58     ]
  59
  60     def guess_payload_class(self, payload):
  61         protocol = {
  62             0x1: LispGPEInnerIP,
  63             0x2: LispGPEInnerIPv6,
  64             0x3: LispGPEInnerEther,
  65             0x4: LispGPEInnerNSH
  66         }
  67         return protocol[self.next_protocol]
  68
  69
  70 class LispGPEInnerIP(IP):
  71     """Scapy inner LISP GPE layer for IPv4-in-IPv4."""
  72
  73     name = u"Lisp GPE Inner Layer - IPv4"
  74
  75
  76 class LispGPEInnerIPv6(IPv6):
  77     """Scapy inner LISP GPE layer for IPv6-in-IPv6."""
  78
  79     name = u"Lisp GPE Inner Layer - IPv6"
  80
  81
  82 class LispGPEInnerEther(Ether):
  83     """Scapy inner LISP GPE layer for Lisp-L2."""
  84
  85     name = u"Lisp GPE Inner Layer - Ethernet"
  86
  87
  88 class LispGPEInnerNSH(Packet):
  89     """Scapy inner LISP GPE layer for Lisp-NSH.
  90
  91     Parsing not implemented.
  92     """
  93
  94
  95 def valid_ipv4(ip_address):
  96     """Check IPv4 address.
  97
  98     :param ip_address: IPv4 address to check.
  99     :type ip_address: str
 100     :returns: True if IP address is correct.
 101     :rtype: bool
 102     """
 103     try:
 104         ipaddress.IPv4Address(ip_address)
 105         return True
 106     except (AttributeError, ipaddress.AddressValueError):
 107         return False
 108
 109
 110 def valid_ipv6(ip_address):
 111     """Check IPv6 address.
 112
 113     :param ip_address: IPv6 address to check.
 114     :type ip_address: str
 115     :returns: True if IP address is correct.
 116     :rtype: bool
 117     """
 118     try:
 119         ipaddress.IPv6Address(ip_address)
 120         return True
 121     except (AttributeError, ipaddress.AddressValueError):
 122         return False
 123
 124
 125 def main():
 126     """Send IP ICMP packet from one traffic generator interface to the other.
 127
 128     :raises RuntimeError: If the received packet is not correct."""
 129
 130     args = TrafficScriptArg(
 131         [
 132             u"tg_src_mac", u"tg_dst_mac", u"src_ip", u"dst_ip", u"dut_if1_mac",
 133             u"dut_if2_mac", u"src_rloc", u"dst_rloc"
 134         ],
 135         [u"ot_mode"]
 136     )
 137
 138     tx_src_mac = args.get_arg(u"tg_src_mac")
 139     tx_dst_mac = args.get_arg(u"dut_if1_mac")
 140     rx_dst_mac = args.get_arg(u"tg_dst_mac")
 141     rx_src_mac = args.get_arg(u"dut_if2_mac")
 142     src_ip = args.get_arg(u"src_ip")
 143     dst_ip = args.get_arg(u"dst_ip")
 144     src_rloc = args.get_arg(u"src_rloc")
 145     dst_rloc = args.get_arg(u"dst_rloc")
 146     tx_if = args.get_arg(u"tx_if")
 147     rx_if = args.get_arg(u"rx_if")
 148     ot_mode = args.get_arg(u"ot_mode")
 149
 150     rxq = RxQueue(rx_if)
 151     txq = TxQueue(tx_if)
 152
 153     pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
 154
 155     if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
 156         pkt_raw /= IP(src=src_ip, dst=dst_ip)
 157         pkt_raw /= ICMP()
 158         ip_format = IP
 159     elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
 160         pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
 161         pkt_raw /= ICMPv6EchoRequest()
 162         ip_format = IPv6
 163     else:
 164         raise ValueError(u"IP not in correct format")
 165
 166     bind_layers(UDP, LispGPEHeader, dport=4341)
 167
 168     pkt_raw /= Raw()
 169     sent_packets = list()
 170     sent_packets.append(pkt_raw)
 171     txq.send(pkt_raw)
 172
 173     while True:
 174         if tx_if == rx_if:
 175             ether = rxq.recv(2, ignore=sent_packets)
 176         else:
 177             ether = rxq.recv(2)
 178
 179         if ether is None:
 180             raise RuntimeError(u"ICMP echo Rx timeout")
 181
 182         if ether.haslayer(ICMPv6ND_NS):
 183             # read another packet in the queue if the current one is ICMPv6ND_NS
 184             continue
 185         if ether.haslayer(ICMPv6ND_RA):
 186             # read another packet in the queue if the current one is ICMPv6ND_RA
 187             continue
 188         elif ether.haslayer(ICMPv6MLReport2):
 189             # read another packet in the queue if the current one is
 190             # ICMPv6MLReport2
 191             continue
 192
 193         # otherwise process the current packet
 194         break
 195
 196     if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
 197         print(u"MAC addresses match.")
 198     else:
 199         raise RuntimeError(f"Matching packet unsuccessful: {ether!r}")
 200
 201     ip = ether.payload
 202
 203     if ot_mode == u"6to4":
 204         if not isinstance(ip, IP):
 205             raise RuntimeError(f"Not an IP packet received {ip!r}")
 206     elif ot_mode == u"4to6":
 207         if not isinstance(ip, IPv6):
 208             raise RuntimeError(f"Not an IP packet received {ip!r}")
 209     elif not isinstance(ip, ip_format):
 210             raise RuntimeError(f"Not an IP packet received {ip!r}")
 211
 212     lisp = ether.getlayer(LispGPEHeader).underlayer
 213     if not lisp:
 214         raise RuntimeError(u"Lisp layer not present or parsing failed.")
 215
 216     # Compare data from packets
 217     if src_ip == lisp.src:
 218         print(u"Source IP matches source EID.")
 219     else:
 220         raise RuntimeError(
 221             f"Matching Src IP unsuccessful: {src_ip} != {lisp.src}"
 222         )
 223
 224     if dst_ip == lisp.dst:
 225         print(u"Destination IP matches destination EID.")
 226     else:
 227         raise RuntimeError(
 228             f"Matching Dst IP unsuccessful: {dst_ip} != {lisp.dst}"
 229         )
 230
 231     if src_rloc == ip.src:
 232         print(u"Source RLOC matches configuration.")
 233     else:
 234         raise RuntimeError(
 235             f"Matching Src RLOC unsuccessful: {src_rloc} != {ip.src}"
 236         )
 237
 238     if dst_rloc == ip.dst:
 239         print(u"Destination RLOC matches configuration.")
 240     else:
 241         raise RuntimeError(
 242             f"Matching dst RLOC unsuccessful: {dst_rloc} != {ip.dst}"
 243         )
 244
 245     sys.exit(0)
 246
 247
 248 if __name__ == u"__main__":
 249     main()