resources/traffic_scripts/ipfix_check.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Cisco and/or its affiliates.
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 """Traffic script - IPFIX listener."""
  17
  18 import sys
  19
  20 from ipaddress import IPv4Address, IPv6Address, AddressValueError
  21 from scapy.layers.inet import IP, TCP, UDP
  22 from scapy.layers.inet6 import IPv6
  23 from scapy.layers.l2 import Ether
  24
  25 from resources.libraries.python.PacketVerifier import RxQueue, TxQueue, auto_pad
  26 from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
  27 from resources.libraries.python.telemetry.IPFIXUtil import IPFIXHandler
  28 from resources.libraries.python.telemetry.IPFIXUtil import IPFIXData
  29
  30
  31 def valid_ipv4(ip):
  32     """Check if IP address has the correct IPv4 address format.
  33
  34     :param ip: IP address.
  35     :type ip: str
  36     :return: True in case of correct IPv4 address format,
  37     otherwise return false.
  38     :rtype: bool
  39     """
  40     try:
  41         IPv4Address(unicode(ip))
  42         return True
  43     except (AttributeError, AddressValueError):
  44         return False
  45
  46
  47 def valid_ipv6(ip):
  48     """Check if IP address has the correct IPv6 address format.
  49
  50     :param ip: IP address.
  51     :type ip: str
  52     :return: True in case of correct IPv6 address format,
  53     otherwise return false.
  54     :rtype: bool
  55     """
  56     try:
  57         IPv6Address(unicode(ip))
  58         return True
  59     except (AttributeError, AddressValueError):
  60         return False
  61
  62
  63 def main():
  64     """Send packets to VPP, then listen for IPFIX flow report. Verify that
  65     the correct packet count was reported."""
  66     args = TrafficScriptArg(
  67         ['src_mac', 'dst_mac', 'src_ip', 'dst_ip', 'protocol', 'port', 'count']
  68     )
  69
  70     dst_mac = args.get_arg('dst_mac')
  71     src_mac = args.get_arg('src_mac')
  72     src_ip = args.get_arg('src_ip')
  73     dst_ip = args.get_arg('dst_ip')
  74     tx_if = args.get_arg('tx_if')
  75
  76     protocol = args.get_arg('protocol')
  77     source_port = int(args.get_arg('port'))
  78     destination_port = int(args.get_arg('port'))
  79     count = int(args.get_arg('count'))
  80
  81     txq = TxQueue(tx_if)
  82     rxq = RxQueue(tx_if)
  83
  84     # generate simple packet based on arguments
  85     if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
  86         ip_version = IP
  87     elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
  88         ip_version = IPv6
  89     else:
  90         raise ValueError("Invalid IP version!")
  91
  92     if protocol.upper() == 'TCP':
  93         protocol = TCP
  94     elif protocol.upper() == 'UDP':
  95         protocol = UDP
  96     else:
  97         raise ValueError("Invalid type of protocol!")
  98
  99     pkt_raw = (Ether(src=src_mac, dst=dst_mac) /
 100                ip_version(src=src_ip, dst=dst_ip) /
 101                protocol(sport=int(source_port),
 102                         dport=int(destination_port)))
 103
 104     # do not print details for sent packets when sending more than one
 105     if count > 1:
 106         verbose = False
 107         print("Sending more than one packet. Details will be filtered for "
 108               "all packets sent.")
 109     else:
 110         verbose = True
 111
 112     pkt_pad = auto_pad(pkt_raw)
 113     ignore = []
 114     for _ in range(count):
 115         txq.send(pkt_pad, verbose=verbose)
 116         ignore.append(pkt_pad)
 117
 118     # allow scapy to recognize IPFIX headers and templates
 119     ipfix = IPFIXHandler()
 120     data = None
 121     # get IPFIX template and data
 122     while True:
 123         pkt = rxq.recv(10, ignore=ignore, verbose=verbose)
 124         if pkt is None:
 125             raise RuntimeError("RX timeout")
 126
 127         if pkt.haslayer("ICMPv6ND_NS"):
 128             # read another packet in the queue if the current one is ICMPv6ND_NS
 129             continue
 130
 131         if pkt.haslayer("IPFIXHeader"):
 132             if pkt.haslayer("IPFIXTemplate"):
 133                 # create or update template for IPFIX data packets
 134                 ipfix.update_template(pkt)
 135             elif pkt.haslayer("IPFIXData"):
 136                 data = pkt.getlayer(IPFIXData).fields
 137                 break
 138             else:
 139                 raise RuntimeError("Unable to parse IPFIX set after header.")
 140         else:
 141             raise RuntimeError("Received non-IPFIX packet or IPFIX header "
 142                                "not recognized.")
 143
 144     # verify packet count
 145     if data["packetTotalCount"] != count:
 146         raise RuntimeError("IPFIX reported wrong packet count. Count was {0},"
 147                            "but should be {1}".format(data["packetTotalCount"],
 148                                                       count))
 149     # verify IP addresses
 150     keys = data.keys()
 151     err = "{0} mismatch. Packets used {1}, but were classified as {2}."
 152     if ip_version == IP:
 153         if "IPv4_src" in keys:
 154             if data["IPv4_src"] != src_ip:
 155                 raise RuntimeError(
 156                     err.format("Source IP", src_ip, data["IPv4_src"]))
 157         if "IPv4_dst" in keys:
 158             if data["IPv4_dst"] != dst_ip:
 159                 raise RuntimeError(
 160                     err.format("Destination IP", dst_ip, data["IPv4_dst"]))
 161     else:
 162         if "IPv6_src" in keys:
 163             if data["IPv6_src"] != src_ip:
 164                 raise RuntimeError(
 165                     err.format("Source IP", src_ip, data["IPv6_src"]))
 166         if "IPv6_dst" in keys:
 167             if data["IPv6_dst"] != dst_ip:
 168                 raise RuntimeError(
 169                     err.format("Source IP", src_ip, data["IPv6_dst"]))
 170     # verify port numbers
 171     for item in ("src_port", "tcp_src_port", "udp_src_port"):
 172         try:
 173             if int(data[item]) != source_port:
 174                 raise RuntimeError(
 175                     err.format("Source port", source_port, data[item]))
 176         except KeyError:
 177             pass
 178     for item in ("dst_port", "tcp_dst_port", "udp_dst_port"):
 179         try:
 180             if int(data[item]) != destination_port:
 181                 raise RuntimeError(
 182                     err.format("Source port", destination_port, data[item]))
 183         except KeyError:
 184             pass
 185     # verify protocol ID
 186     if "Protocol_ID" in keys:
 187         if protocol == TCP and int(data["Protocol_ID"]) != 6:
 188             raise RuntimeError("TCP Packets were classified as not TCP.")
 189         if protocol == UDP and int(data["Protocol_ID"]) != 17:
 190             raise RuntimeError("UDP Packets were classified as not UDP.")
 191     sys.exit(0)
 192
 193
 194 if __name__ == "__main__":
 195     main()