resources/traffic_scripts/send_ip_icmp.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2016 Cisco and/or its affiliates.
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at:
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 """Traffic script that sends an IP ICMPv4/ICMPv6 packet
  16 from one interface to the other one."""
  17
  18 import sys
  19 import ipaddress
  20
  21 from scapy.layers.inet import ICMP, IP
  22 from scapy.all import Ether
  23 from scapy.layers.inet6 import ICMPv6EchoRequest
  24 from scapy.layers.inet6 import IPv6
  25
  26 from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
  27 from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
  28
  29
  30 def valid_ipv4(ip):
  31     """Check if IP address has the correct IPv4 address format.
  32
  33     :param ip: IP address.
  34     :type ip: str
  35     :return: True in case of correct IPv4 address format,
  36     otherwise return false.
  37     :rtype: bool
  38     """
  39     try:
  40         ipaddress.IPv4Address(unicode(ip))
  41         return True
  42     except (AttributeError, ipaddress.AddressValueError):
  43         return False
  44
  45
  46 def valid_ipv6(ip):
  47     """Check if IP address has the correct IPv6 address format.
  48
  49     :param ip: IP address.
  50     :type ip: str
  51     :return: True in case of correct IPv6 address format,
  52     otherwise return false.
  53     :rtype: bool
  54     """
  55     try:
  56         ipaddress.IPv6Address(unicode(ip))
  57         return True
  58     except (AttributeError, ipaddress.AddressValueError):
  59         return False
  60
  61
  62 def main():
  63     """Send IP ICMPv4/ICMPv6 packet from one traffic generator interface to
  64     the other one.
  65     """
  66     args = TrafficScriptArg(['src_mac', 'dst_mac', 'src_ip', 'dst_ip'])
  67
  68     src_mac = args.get_arg('src_mac')
  69     dst_mac = args.get_arg('dst_mac')
  70     src_ip = args.get_arg('src_ip')
  71     dst_ip = args.get_arg('dst_ip')
  72     tx_if = args.get_arg('tx_if')
  73     rx_if = args.get_arg('rx_if')
  74
  75     rxq = RxQueue(rx_if)
  76     txq = TxQueue(tx_if)
  77
  78     sent_packets = []
  79     ip_format = ''
  80     icmp_format = ''
  81     # Create empty ip ICMP packet and add padding before sending
  82     if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
  83         pkt_raw = (Ether(src=src_mac, dst=dst_mac) /
  84                    IP(src=src_ip, dst=dst_ip) /
  85                    ICMP())
  86         ip_format = 'IP'
  87         icmp_format = 'ICMP'
  88     elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
  89         pkt_raw = (Ether(src=src_mac, dst=dst_mac) /
  90                    IPv6(src=src_ip, dst=dst_ip) /
  91                    ICMPv6EchoRequest())
  92         ip_format = 'IPv6'
  93         icmp_format = 'ICMPv6EchoRequest'
  94     else:
  95         raise ValueError("IP(s) not in correct format")
  96
  97     # Send created packet on one interface and receive on the other
  98     sent_packets.append(pkt_raw)
  99     txq.send(pkt_raw)
 100
 101     ether = rxq.recv(2)
 102
 103     # Check whether received packet contains layers Ether, IP and ICMP
 104     if ether is None:
 105         raise RuntimeError('ICMP echo Rx timeout')
 106
 107     if not ether.haslayer(ip_format):
 108         raise RuntimeError('Not an IP packet received {0}'
 109                            .format(ether.__repr__()))
 110
 111     if not ether.haslayer(icmp_format):
 112         raise RuntimeError('Not an ICMP packet received {0}'
 113                            .format(ether.__repr__()))
 114
 115     sys.exit(0)
 116
 117 if __name__ == "__main__":
 118     main()