GPL/traffic_scripts/lisp/lisp_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 LISP-encapsulated packet on the other interface and verifies received packet.
  28 """
  29
  30 import sys
  31 import ipaddress
  32
  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, ICMPv6ND_RA
  38 from scapy.layers.l2 import Ether
  39 from scapy.packet import Raw
  40
  41 from ..PacketVerifier import RxQueue, TxQueue
  42 from ..TrafficScriptArg import TrafficScriptArg
  43
  44
  45 class LispHeader(Packet):
  46     """Scapy header for the LISP Layer."""
  47
  48     name = u"Lisp Header"
  49     fields_desc = [
  50         FlagsField(
  51             u"flags", None, 8, [u"N", u"L", u"E", u"V", u"I", u"", u"", u""]
  52         ),
  53         BitField(u"nonce/map_version", 0, size=24),
  54         IntField(u"instance_id/locator_status_bits", 0)]
  55
  56
  57 class LispInnerIP(IP):
  58     """Scapy inner LISP layer for IPv4-in-IPv4."""
  59
  60     name = u"Lisp Inner Layer - IPv4"
  61
  62
  63 class LispInnerIPv6(IPv6):
  64     """Scapy inner LISP layer for IPv6-in-IPv6."""
  65
  66     name = u"Lisp Inner Layer - IPv6"
  67
  68
  69 def valid_ipv4(ip_address):
  70     """Check IPv4 address.
  71
  72     :param ip_address: IPv4 address to check.
  73     :type ip_address: str
  74     :returns: True if IP address is correct.
  75     :rtype: bool
  76     """
  77     try:
  78         ipaddress.IPv4Address(ip_address)
  79         return True
  80     except (AttributeError, ipaddress.AddressValueError):
  81         return False
  82
  83
  84 def valid_ipv6(ip_address):
  85     """Check IPv6 address.
  86
  87     :param ip_address: IPv6 address to check.
  88     :type ip_address: str
  89     :returns: True if IP address is correct.
  90     :rtype: bool
  91     """
  92     try:
  93         ipaddress.IPv6Address(ip_address)
  94         return True
  95     except (AttributeError, ipaddress.AddressValueError):
  96         return False
  97
  98
  99 def main():
 100     """Send IP ICMP packet from one traffic generator interface to the other.
 101
 102     :raises RuntimeError: If the received packet is not correct.
 103     """
 104
 105     args = TrafficScriptArg(
 106         [
 107             u"tg_src_mac", u"tg_dst_mac", u"src_ip", u"dst_ip", u"dut_if1_mac",
 108             u"dut_if2_mac", u"src_rloc", u"dst_rloc"
 109         ],
 110         [u"ot_mode"]
 111     )
 112
 113     tx_src_mac = args.get_arg(u"tg_src_mac")
 114     tx_dst_mac = args.get_arg(u"dut_if1_mac")
 115     rx_dst_mac = args.get_arg(u"tg_dst_mac")
 116     rx_src_mac = args.get_arg(u"dut_if2_mac")
 117     src_ip = args.get_arg(u"src_ip")
 118     dst_ip = args.get_arg(u"dst_ip")
 119     src_rloc = args.get_arg(u"src_rloc")
 120     dst_rloc = args.get_arg(u"dst_rloc")
 121     tx_if = args.get_arg(u"tx_if")
 122     rx_if = args.get_arg(u"rx_if")
 123     ot_mode = args.get_arg(u"ot_mode")
 124
 125     rxq = RxQueue(rx_if)
 126     txq = TxQueue(tx_if)
 127
 128     pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
 129
 130     if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
 131         pkt_raw /= IP(src=src_ip, dst=dst_ip)
 132         pkt_raw /= ICMP()
 133         ip_format = IP
 134         lisp_layer = LispInnerIP
 135     elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
 136         pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
 137         pkt_raw /= ICMPv6EchoRequest()
 138         ip_format = IPv6
 139         lisp_layer = LispInnerIPv6
 140     else:
 141         raise ValueError(u"IP not in correct format")
 142
 143     bind_layers(UDP, LispHeader, dport=4341)
 144     bind_layers(LispHeader, lisp_layer)
 145
 146     pkt_raw /= Raw()
 147     sent_packets = list()
 148     sent_packets.append(pkt_raw)
 149     txq.send(pkt_raw)
 150
 151     while True:
 152         if tx_if == rx_if:
 153             ether = rxq.recv(2, ignore=sent_packets)
 154         else:
 155             ether = rxq.recv(2)
 156
 157         if ether is None:
 158             raise RuntimeError(u"ICMP echo Rx timeout")
 159
 160         if ether.haslayer(ICMPv6ND_NS):
 161             # read another packet in the queue if the current one is ICMPv6ND_NS
 162             continue
 163         elif ether.haslayer(ICMPv6MLReport2):
 164             # read another packet in the queue if the current one is
 165             # ICMPv6MLReport2
 166             continue
 167         elif ether.haslayer(ICMPv6ND_RA):
 168             # read another packet in the queue if the current one is
 169             # ICMPv6ND_RA
 170             continue
 171
 172         # otherwise process the current packet
 173         break
 174
 175     if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
 176         print(u"MAC addresses match.")
 177     else:
 178         raise RuntimeError(f"Matching packet unsuccessful: {ether!r}")
 179
 180     ip = ether.payload
 181
 182     if ot_mode == u"6to4":
 183         if not isinstance(ip, IP):
 184             raise RuntimeError(f"Not an IP packet received {ip!r}")
 185     elif ot_mode == u"4to6":
 186         if not isinstance(ip, IPv6):
 187             raise RuntimeError(f"Not an IP packet received {ip!r}")
 188     elif not isinstance(ip, ip_format):
 189             raise RuntimeError(f"Not an IP packet received {ip!r}")
 190
 191     lisp = ether.getlayer(lisp_layer)
 192     if not lisp:
 193         raise RuntimeError("Lisp layer not present or parsing failed.")
 194
 195     # Compare data from packets
 196     if src_ip == lisp.src:
 197         print(u"Source IP matches source EID.")
 198     else:
 199         raise RuntimeError(
 200             f"Matching Src IP unsuccessful: {src_ip} != {lisp.src}"
 201         )
 202
 203     if dst_ip == lisp.dst:
 204         print(u"Destination IP matches destination EID.")
 205     else:
 206         raise RuntimeError(
 207             f"Matching Dst IP unsuccessful: {dst_ip} != {lisp.dst}"
 208         )
 209
 210     if src_rloc == ip.src:
 211         print(u"Source RLOC matches configuration.")
 212     else:
 213         raise RuntimeError(
 214             f"Matching Src RLOC unsuccessful: {src_rloc} != {ip.src}"
 215         )
 216
 217     if dst_rloc == ip.dst:
 218         print(u"Destination RLOC matches configuration.")
 219     else:
 220         raise RuntimeError(
 221             f"Matching dst RLOC unsuccessful: {dst_rloc} != {ip.dst}"
 222         )
 223
 224     sys.exit(0)
 225
 226
 227 if __name__ == u"__main__":
 228     main()