-#!/usr/bin/env python
+#!/usr/bin/env python3
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
import sys
import logging
-logging.getLogger("scapy.runtime").setLevel(logging.ERROR)
-from scapy.all import Ether, IP, ICMP, IPv6, ICMPv6EchoRequest, ICMPv6EchoReply
-from scapy.layers.ipsec import SecurityAssociation, ESP
from ipaddress import ip_address
+# pylint: disable=no-name-in-module
+# pylint: disable=import-error
+logging.getLogger(u"scapy.runtime").setLevel(logging.ERROR)
+from scapy.layers.inet import IP
+from scapy.layers.inet6 import IPv6, ICMPv6ND_NS
+from scapy.layers.ipsec import SecurityAssociation, ESP
+from scapy.layers.l2 import Ether
+from scapy.packet import Raw
-from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
-def check_ipv4(pkt_recv, dst_tun, src_ip, dst_ip, sa_in):
- """Check received IPv4 IPsec packet.
+def check_ipsec(pkt_recv, ip_layer, dst_tun, src_ip, dst_ip, sa_in):
+ """Check received IPsec packet.
:param pkt_recv: Received packet to verify.
+ :param ip_layer: Scapy IP layer.
:param dst_tun: IPsec tunnel destination address.
- :param src_ip: Source address of original IPv4 packet.
- :param dst_ip: Destination address of original IPv4 packet.
+ :param src_ip: Source IP/IPv6 address of original IP/IPv6 packet.
+ :param dst_ip: Destination IP/IPv6 address of original IP/IPv6 packet.
:param sa_in: IPsec SA for packet decryption.
:type pkt_recv: scapy.Ether
+ :type ip_layer: scapy.layers.inet.IP or scapy.layers.inet6.IPv6
:type dst_tun: str
:type src_ip: str
:type dst_ip: str
- :type sa_sa: scapy.layers.ipsec.SecurityAssociation
+ :type sa_in: scapy.layers.ipsec.SecurityAssociation
:raises RuntimeError: If received packet is invalid.
"""
- if not pkt_recv.haslayer(IP):
+ if not pkt_recv.haslayer(ip_layer):
raise RuntimeError(
- 'Not an IPv4 packet received: {0}'.format(pkt_recv.__repr__()))
+ f"Not an {ip_layer.name} packet received: {pkt_recv!r}"
+ )
- if pkt_recv['IP'].dst != dst_tun:
+ if pkt_recv[ip_layer].dst != dst_tun:
raise RuntimeError(
- 'Received packet has invalid destination address: {0} '
- 'should be: {1}'.format(pkt_recv['IP'].dst, dst_tun))
+ f"Received packet has invalid destination address: "
+ f"{pkt_recv[ip_layer].dst} should be: {dst_tun}"
+ )
if not pkt_recv.haslayer(ESP):
- raise RuntimeError(
- 'Not an ESP packet received: {0}'.format(pkt_recv.__repr__()))
+ raise RuntimeError(f"Not an ESP packet received: {pkt_recv!r}")
- ip_pkt = pkt_recv['IP']
+ ip_pkt = pkt_recv[ip_layer]
d_pkt = sa_in.decrypt(ip_pkt)
- if d_pkt['IP'].dst != dst_ip:
+ if d_pkt[ip_layer].dst != dst_ip:
raise RuntimeError(
- 'Decrypted packet has invalid destination address: {0} '
- 'should be: {1}'.format(d_pkt['IP'].dst, dst_ip))
+ f"Decrypted packet has invalid destination address: "
+ f"{d_pkt[ip_layer].dst} should be: {dst_ip}"
+ )
- if d_pkt['IP'].src != src_ip:
+ if d_pkt[ip_layer].src != src_ip:
raise RuntimeError(
- 'Decrypted packet has invalid source address: {0} should be: {1}'
- .format(d_pkt['IP'].src, src_ip))
+ f"Decrypted packet has invalid source address: "
+ f"{d_pkt[ip_layer].src} should be: {src_ip}"
+ )
- if not d_pkt.haslayer(ICMP):
+ if ip_layer == IP and d_pkt[ip_layer].proto != 61:
raise RuntimeError(
- 'Decrypted packet does not have ICMP layer: {0}'.format(
- d_pkt.__repr__()))
+ f"Decrypted packet has invalid IP protocol: "
+ f"{d_pkt[ip_layer].proto} should be: 61"
+ )
-def check_ipv6(pkt_recv, dst_tun, src_ip, dst_ip, sa_in):
- """Check received IPv6 IPsec packet.
+def check_ip(pkt_recv, ip_layer, src_ip, dst_ip):
+ """Check received IP/IPv6 packet.
:param pkt_recv: Received packet to verify.
- :param dst_tun: IPsec tunnel destination address.
- :param src_ip: Source address of original IPv6 packet.
- :param dst_ip: Destination address of original IPv6 packet.
- :param sa_in: IPsec SA for packet decryption.
+ :param ip_layer: Scapy IP layer.
+ :param src_ip: Source IP/IPv6 address.
+ :param dst_ip: Destination IP/IPv6 address.
:type pkt_recv: scapy.Ether
- :type dst_tun: str
+ :type ip_layer: scapy.layers.inet.IP or scapy.layers.inet6.IPv6
:type src_ip: str
:type dst_ip: str
- :type sa_in: scapy.layers.ipsec.SecurityAssociation
:raises RuntimeError: If received packet is invalid.
"""
- if not pkt_recv.haslayer(IPv6):
+ if not pkt_recv.haslayer(ip_layer):
raise RuntimeError(
- 'Not an IPv6 packet received: {0}'.format(pkt_recv.__repr__()))
+ f"Not an {ip_layer.name} packet received: {pkt_recv!r}"
+ )
- if pkt_recv['IPv6'].dst != dst_tun:
+ if pkt_recv[ip_layer].dst != dst_ip:
raise RuntimeError(
- 'Received packet has invalid destination address: {0} '
- 'should be: {1}'.format(pkt_recv['IPv6'].dst, dst_tun))
+ f"Received packet has invalid destination address: "
+ f"{pkt_recv[ip_layer.name].dst} should be: {dst_ip}"
+ )
- if not pkt_recv.haslayer(ESP):
+ if pkt_recv[ip_layer].src != src_ip:
raise RuntimeError(
- 'Not an ESP packet received: {0}'.format(pkt_recv.__repr__()))
+ f"Received packet has invalid destination address: "
+ f"{pkt_recv[ip_layer.name].dst} should be: {src_ip}"
+ )
- ip_pkt = pkt_recv['IPv6']
- d_pkt = sa_in.decrypt(ip_pkt)
-
- if d_pkt['IPv6'].dst != dst_ip:
+ if ip_layer == IP and pkt_recv[ip_layer].proto != 61:
raise RuntimeError(
- 'Decrypted packet has invalid destination address {0}: '
- 'should be: {1}'.format(d_pkt['IPv6'].dst, dst_ip))
-
- if d_pkt['IPv6'].src != src_ip:
- raise RuntimeError(
- 'Decrypted packet has invalid source address: {0} should be: {1}'
- .format(d_pkt['IPv6'].src, src_ip))
-
- if not d_pkt.haslayer(ICMPv6EchoReply):
- raise RuntimeError(
- 'Decrypted packet does not have ICMP layer: {0}'.format(
- d_pkt.__repr__()))
+ f"Received packet has invalid IP protocol: "
+ f"{pkt_recv[ip_layer].proto} should be: 61"
+ )
# pylint: disable=too-many-locals
# pylint: disable=too-many-statements
def main():
"""Send and receive IPsec packet."""
- args = TrafficScriptArg(['src_mac', 'dst_mac', 'src_ip', 'dst_ip',
- 'crypto_alg', 'crypto_key', 'integ_alg',
- 'integ_key', 'l_spi', 'r_spi'],
- ['src_tun', 'dst_tun'])
-
- rxq = RxQueue(args.get_arg('rx_if'))
- txq = TxQueue(args.get_arg('tx_if'))
-
- src_mac = args.get_arg('src_mac')
- dst_mac = args.get_arg('dst_mac')
- src_ip = args.get_arg('src_ip')
- dst_ip = args.get_arg('dst_ip')
- crypto_alg = args.get_arg('crypto_alg')
- crypto_key = args.get_arg('crypto_key')
- integ_alg = args.get_arg('integ_alg')
- integ_key = args.get_arg('integ_key')
- l_spi = int(args.get_arg('l_spi'))
- r_spi = int(args.get_arg('r_spi'))
- src_tun = args.get_arg('src_tun')
- dst_tun = args.get_arg('dst_tun')
-
- is_ipv4 = True
- if 6 == ip_address(unicode(src_ip)).version:
- is_ipv4 = False
-
- tunnel_out = None
- tunnel_in = None
-
- if src_tun and dst_tun:
- if is_ipv4:
- tunnel_out = IP(src=src_tun, dst=dst_tun)
- tunnel_in = IP(src=dst_tun, dst=src_tun)
- else:
- tunnel_out = IPv6(src=src_tun, dst=dst_tun)
- tunnel_in = IPv6(src=dst_tun, dst=src_tun)
- else:
+
+ args = TrafficScriptArg(
+ [
+ u"tx_src_mac", u"tx_dst_mac", u"rx_src_mac", u"rx_dst_mac",
+ u"src_ip", u"dst_ip", u"crypto_alg", u"crypto_key", u"integ_alg",
+ u"integ_key", u"l_spi", u"r_spi"
+ ],
+ [u"src_tun", u"dst_tun"]
+ )
+
+ tx_txq = TxQueue(args.get_arg(u"tx_if"))
+ tx_rxq = RxQueue(args.get_arg(u"tx_if"))
+ rx_txq = TxQueue(args.get_arg(u"rx_if"))
+ rx_rxq = RxQueue(args.get_arg(u"rx_if"))
+
+ tx_src_mac = args.get_arg(u"tx_src_mac")
+ tx_dst_mac = args.get_arg(u"tx_dst_mac")
+ rx_src_mac = args.get_arg(u"rx_src_mac")
+ rx_dst_mac = args.get_arg(u"rx_dst_mac")
+ src_ip = args.get_arg(u"src_ip")
+ dst_ip = args.get_arg(u"dst_ip")
+ crypto_alg = args.get_arg(u"crypto_alg")
+ crypto_key = args.get_arg(u"crypto_key")
+ integ_alg = args.get_arg(u"integ_alg")
+ integ_key = args.get_arg(u"integ_key")
+ l_spi = int(args.get_arg(u"l_spi"))
+ r_spi = int(args.get_arg(u"r_spi"))
+ src_tun = args.get_arg(u"src_tun")
+ dst_tun = args.get_arg(u"dst_tun")
+
+ ip_layer = IP if ip_address(src_ip).version == 4 else IPv6
+
+ tunnel_out = ip_layer(src=src_tun, dst=dst_tun) if src_tun and dst_tun \
+ else None
+ tunnel_in = ip_layer(src=dst_tun, dst=src_tun) if src_tun and dst_tun \
+ else None
+
+ if not (src_tun and dst_tun):
src_tun = src_ip
- dst_tun = dst_ip
- sa_in = SecurityAssociation(ESP, spi=r_spi, crypt_algo=crypto_alg,
- crypt_key=crypto_key, auth_algo=integ_alg,
- auth_key=integ_key, tunnel_header=tunnel_in)
+ sa_in = SecurityAssociation(
+ ESP, spi=r_spi, crypt_algo=crypto_alg,
+ crypt_key=crypto_key.encode(encoding=u"utf-8"), auth_algo=integ_alg,
+ auth_key=integ_key.encode(encoding=u"utf-8"), tunnel_header=tunnel_in
+ )
- sa_out = SecurityAssociation(ESP, spi=l_spi, crypt_algo=crypto_alg,
- crypt_key=crypto_key, auth_algo=integ_alg,
- auth_key=integ_key, tunnel_header=tunnel_out)
+ sa_out = SecurityAssociation(
+ ESP, spi=l_spi, crypt_algo=crypto_alg,
+ crypt_key=crypto_key.encode(encoding=u"utf-8"), auth_algo=integ_alg,
+ auth_key=integ_key.encode(encoding=u"utf-8"), tunnel_header=tunnel_out
+ )
- sent_packets = []
+ ip_pkt = ip_layer(src=src_ip, dst=dst_ip, proto=61) if ip_layer == IP \
+ else ip_layer(src=src_ip, dst=dst_ip)
+ ip_pkt = ip_layer(ip_pkt)
- ip_pkt = None
+ e_pkt = sa_out.encrypt(ip_pkt)
+ tx_pkt_send = (Ether(src=tx_src_mac, dst=tx_dst_mac) /
+ e_pkt)
- if is_ipv4:
- ip_pkt = IP(src=src_ip, dst=dst_ip) / \
- ICMP()
- ip_pkt = IP(str(ip_pkt))
- else:
- ip_pkt = IPv6(src=src_ip, dst=dst_ip) / \
- ICMPv6EchoRequest()
- ip_pkt = IPv6(str(ip_pkt))
+ sent_packets = list()
+ tx_pkt_send /= Raw()
+ sent_packets.append(tx_pkt_send)
+ tx_txq.send(tx_pkt_send)
- e_pkt = sa_out.encrypt(ip_pkt)
- pkt_send = Ether(src=src_mac, dst=dst_mac) / \
- e_pkt
+ while True:
+ rx_pkt_recv = rx_rxq.recv(2)
+
+ if rx_pkt_recv is None:
+ raise RuntimeError(f"{ip_layer.name} packet Rx timeout")
- sent_packets.append(pkt_send)
- txq.send(pkt_send)
+ if rx_pkt_recv.haslayer(ICMPv6ND_NS):
+ # read another packet in the queue if the current one is ICMPv6ND_NS
+ continue
+ else:
+ # otherwise process the current packet
+ break
+
+ check_ip(rx_pkt_recv, ip_layer, src_ip, dst_ip)
- pkt_recv = rxq.recv(2, sent_packets)
+ rx_ip_pkt = ip_layer(src=dst_ip, dst=src_ip, proto=61) if ip_layer == IP \
+ else ip_layer(src=dst_ip, dst=src_ip)
+ rx_pkt_send = (Ether(src=rx_dst_mac, dst=rx_src_mac) /
+ rx_ip_pkt)
- if pkt_recv is None:
- raise RuntimeError('Rx timeout')
+ rx_pkt_send /= Raw()
+ rx_txq.send(rx_pkt_send)
- if is_ipv4:
- check_ipv4(pkt_recv, src_tun, dst_ip, src_ip, sa_in)
- else:
- check_ipv6(pkt_recv, src_tun, dst_ip, src_ip, sa_in)
+ while True:
+ tx_pkt_recv = tx_rxq.recv(2, sent_packets)
+
+ if tx_pkt_recv is None:
+ raise RuntimeError(u"ESP packet Rx timeout")
+
+ if tx_pkt_recv.haslayer(ICMPv6ND_NS):
+ # read another packet in the queue if the current one is ICMPv6ND_NS
+ continue
+ else:
+ # otherwise process the current packet
+ break
+
+ check_ipsec(tx_pkt_recv, ip_layer, src_tun, dst_ip, src_ip, sa_in)
sys.exit(0)
-if __name__ == "__main__":
+
+if __name__ == u"__main__":
main()
Code Review / csit.git / blobdiff