#!/usr/bin/env python3
from __future__ import print_function

"""ACL plugin - MACIP tests
"""
import binascii
import ipaddress
import random
from socket import inet_ntop, inet_pton, AF_INET, AF_INET6
from struct import pack, unpack
import re
import unittest
from ipaddress import ip_network, IPv4Network, IPv6Network

import scapy.compat
from scapy.packet import Raw
from scapy.layers.l2 import Ether
from scapy.layers.inet import IP, UDP
from scapy.layers.inet6 import IPv6

from framework import VppTestCase, VppTestRunner
from vpp_lo_interface import VppLoInterface
from vpp_l2 import L2_PORT_TYPE
from vpp_sub_interface import (
    L2_VTR_OP,
    VppSubInterface,
    VppDot1QSubint,
    VppDot1ADSubint,
)
from vpp_acl import (
    AclRule,
    VppAcl,
    VppAclInterface,
    VppEtypeWhitelist,
    VppMacipAclInterface,
    VppMacipAcl,
    MacipRule,
)
from vpp_papi import MACAddress


class MethodHolder(VppTestCase):
    DEBUG = False

    BRIDGED = True
    ROUTED = False

    IS_IP4 = False
    IS_IP6 = True

    DOT1AD = "dot1ad"
    DOT1Q = "dot1q"
    PERMIT_TAGS = True
    DENY_TAGS = False

    # rule types
    DENY = 0
    PERMIT = 1

    # ACL types
    EXACT_IP = 1
    SUBNET_IP = 2
    WILD_IP = 3

    EXACT_MAC = 1
    WILD_MAC = 2
    OUI_MAC = 3

    ACLS = []

    @classmethod
    def setUpClass(cls):
        """
        Perform standard class setup (defined by class method setUpClass in
        class VppTestCase) before running the test case, set test case related
        variables and configure VPP.
        """
        super(MethodHolder, cls).setUpClass()

        cls.pg_if_packet_sizes = [64, 512, 1518, 9018]  # packet sizes
        cls.bd_id = 111
        cls.remote_hosts_count = 200

        try:
            # create 4 pg interfaces, 1 loopback interface
            cls.create_pg_interfaces(range(4))
            cls.create_loopback_interfaces(1)

            # create 2 subinterfaces
            cls.subifs = [
                VppDot1QSubint(cls, cls.pg1, 10),
                VppDot1ADSubint(cls, cls.pg2, 20, 300, 400),
                VppDot1QSubint(cls, cls.pg3, 30),
                VppDot1ADSubint(cls, cls.pg3, 40, 600, 700),
            ]

            cls.subifs[0].set_vtr(L2_VTR_OP.L2_POP_1, inner=10, push1q=1)
            cls.subifs[1].set_vtr(L2_VTR_OP.L2_POP_2, outer=300, inner=400, push1q=1)
            cls.subifs[2].set_vtr(L2_VTR_OP.L2_POP_1, inner=30, push1q=1)
            cls.subifs[3].set_vtr(L2_VTR_OP.L2_POP_2, outer=600, inner=700, push1q=1)

            cls.interfaces = list(cls.pg_interfaces)
            cls.interfaces.extend(cls.lo_interfaces)
            cls.interfaces.extend(cls.subifs)

            for i in cls.interfaces:
                i.admin_up()

            # Create BD with MAC learning enabled and put interfaces to this BD
            cls.vapi.sw_interface_set_l2_bridge(
                rx_sw_if_index=cls.loop0.sw_if_index,
                bd_id=cls.bd_id,
                port_type=L2_PORT_TYPE.BVI,
            )
            cls.vapi.sw_interface_set_l2_bridge(
                rx_sw_if_index=cls.pg0.sw_if_index, bd_id=cls.bd_id
            )
            cls.vapi.sw_interface_set_l2_bridge(
                rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.bd_id
            )
            cls.vapi.sw_interface_set_l2_bridge(
                rx_sw_if_index=cls.subifs[0].sw_if_index, bd_id=cls.bd_id
            )
            cls.vapi.sw_interface_set_l2_bridge(
                rx_sw_if_index=cls.subifs[1].sw_if_index, bd_id=cls.bd_id
            )

            # Configure IPv4/6 addresses on loop interface and routed interface
            cls.loop0.config_ip4()
            cls.loop0.config_ip6()
            cls.pg2.config_ip4()
            cls.pg2.config_ip6()
            cls.pg3.config_ip4()
            cls.pg3.config_ip6()

            # Configure MAC address binding to IPv4 neighbors on loop0
            cls.loop0.generate_remote_hosts(cls.remote_hosts_count)
            # Modify host mac addresses to have different OUI parts
            for i in range(2, cls.remote_hosts_count + 2):
                mac = cls.loop0.remote_hosts[i - 2]._mac.split(":")
                mac[2] = format(int(mac[2], 16) + i, "02x")
                cls.loop0.remote_hosts[i - 2]._mac = ":".join(mac)

            cls.loop0.configure_ipv4_neighbors()
            cls.loop0.configure_ipv6_neighbors()

            # configure MAC address on pg3
            cls.pg3.resolve_arp()
            cls.pg3.resolve_ndp()

            # configure MAC address on subifs
            for i in cls.subifs:
                i.config_ip4()
                i.resolve_arp()
                i.config_ip6()

            # configure MAC address on pg2
            cls.pg2.resolve_arp()
            cls.pg2.resolve_ndp()

            # Loopback BVI interface has remote hosts
            # one half of hosts are behind pg0 second behind pg1,pg2,pg3 subifs
            cls.pg0.remote_hosts = cls.loop0.remote_hosts[:100]
            cls.subifs[0].remote_hosts = cls.loop0.remote_hosts[100:125]
            cls.subifs[1].remote_hosts = cls.loop0.remote_hosts[125:150]
            cls.subifs[2].remote_hosts = cls.loop0.remote_hosts[150:175]
            cls.subifs[3].remote_hosts = cls.loop0.remote_hosts[175:]

        except Exception:
            super(MethodHolder, cls).tearDownClass()
            raise

    @classmethod
    def tearDownClass(cls):
        super(MethodHolder, cls).tearDownClass()

    def setUp(self):
        super(MethodHolder, self).setUp()
        self.reset_packet_infos()

    def show_commands_at_teardown(self):
        self.logger.info(self.vapi.ppcli("show interface address"))
        self.logger.info(self.vapi.ppcli("show hardware"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip acl"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip interface"))
        self.logger.info(self.vapi.ppcli("sh classify tables verbose"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin acl"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin interface"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin tables"))
        # print(self.vapi.ppcli("show interface address"))
        # print(self.vapi.ppcli("show hardware"))
        # print(self.vapi.ppcli("sh acl-plugin macip interface"))
        # print(self.vapi.ppcli("sh acl-plugin macip acl"))

    def macip_acl_dump_debug(self):
        acls = self.vapi.macip_acl_dump()
        if self.DEBUG:
            for acl in acls:
                # print("ACL #"+str(acl.acl_index))
                for r in acl.r:
                    rule = "ACTION"
                    if r.is_permit == 1:
                        rule = "PERMIT"
                    elif r.is_permit == 0:
                        rule = "DENY  "
                    """
                    print("    IP6" if r.is_ipv6 else "    IP4",
                          rule,
                          binascii.hexlify(r.src_mac),
                          binascii.hexlify(r.src_mac_mask),
                          unpack('<16B', r.src_ip_addr),
                          r.src_ip_prefix_len)
                    """
        return acls

    def create_rules(
        self, mac_type=EXACT_MAC, ip_type=EXACT_IP, acl_count=1, rules_count=None
    ):
        acls = []
        if rules_count is None:
            rules_count = [1]
        src_mac = int("220000dead00", 16)
        for acl in range(2, (acl_count + 1) * 2):
            rules = []
            host = random.choice(self.loop0.remote_hosts)
            is_ip6 = acl % 2
            ip4 = host.ip4.split(".")
            ip6 = list(unpack("<16B", inet_pton(AF_INET6, host.ip6)))

            if ip_type == self.EXACT_IP:
                prefix_len4 = 32
                prefix_len6 = 128
            elif ip_type == self.WILD_IP:
                ip4 = [0, 0, 0, 0]
                ip6 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
                prefix_len4 = 0
                prefix_len6 = 0
                rules_count[int((acl / 2) - 1)] = 1
            else:
                prefix_len4 = 24
                prefix_len6 = 64

            if mac_type == self.EXACT_MAC:
                mask = "ff:ff:ff:ff:ff:ff"
            elif mac_type == self.WILD_MAC:
                mask = "00:00:00:00:00:00"
            elif mac_type == self.OUI_MAC:
                mask = "ff:ff:ff:00:00:00"
            else:
                mask = "ff:ff:ff:ff:ff:00"

            ip = ip6 if is_ip6 else ip4
            ip_len = prefix_len6 if is_ip6 else prefix_len4

            for i in range(0, (rules_count[int((acl / 2) - 1)])):
                src_mac += 16777217
                if mac_type == self.WILD_MAC:
                    mac = "00:00:00:00:00:00"
                elif mac_type == self.OUI_MAC:
                    mac = (
                        ":".join(re.findall("..", "{:02x}".format(src_mac))[:3])
                        + ":00:00:00"
                    )
                else:
                    mac = ":".join(re.findall("..", "{:02x}".format(src_mac)))

                if ip_type == self.EXACT_IP:
                    ip4[3] = random.randint(100, 200)
                    ip6[15] = random.randint(100, 200)
                elif ip_type == self.SUBNET_IP:
                    ip4[2] = random.randint(100, 200)
                    ip4[3] = 0
                    ip6[7] = random.randint(100, 200)
                    ip6[15] = 0
                ip_pack = b""
                for j in range(0, len(ip)):
                    ip_pack += pack("<B", int(ip[j]))

                rule = MacipRule(
                    is_permit=self.PERMIT,
                    src_prefix=ip_network((ip_pack, ip_len)),
                    src_mac=MACAddress(mac).packed,
                    src_mac_mask=MACAddress(mask).packed,
                )
                rules.append(rule)
                if ip_type == self.WILD_IP:
                    break

            acls.append(rules)
            src_mac += 1099511627776
        return acls

    def apply_macip_rules(self, acls):
        macip_acls = []
        for acl in acls:
            macip_acl = VppMacipAcl(self, rules=acl)
            macip_acl.add_vpp_config()
            macip_acls.append(macip_acl)
        return macip_acls

    def verify_macip_acls(self, acl_count, rules_count, expected_count=2):
        reply = self.macip_acl_dump_debug()
        for acl in range(2, (acl_count + 1) * 2):
            self.assertEqual(reply[acl - 2].count, rules_count[acl // 2 - 1])

        self.vapi.macip_acl_interface_get()

        self.vapi.macip_acl_interface_add_del(sw_if_index=0, acl_index=0)
        self.vapi.macip_acl_interface_add_del(sw_if_index=1, acl_index=1)

        reply = self.vapi.macip_acl_interface_get()
        self.assertEqual(reply.count, expected_count)

    def create_stream(
        self,
        mac_type,
        ip_type,
        packet_count,
        src_if,
        dst_if,
        traffic,
        is_ip6,
        tags=PERMIT_TAGS,
    ):
        # exact MAC and exact IP
        # exact MAC and subnet of IPs
        # exact MAC and wildcard IP
        # wildcard MAC and exact IP
        # wildcard MAC and subnet of IPs
        # wildcard MAC and wildcard IP
        # OUI restricted MAC and exact IP
        # OUI restricted MAC and subnet of IPs
        # OUI restricted MAC and wildcard IP

        packets = []
        macip_rules = []
        acl_rules = []
        ip_permit = ""
        mac_permit = ""
        dst_mac = ""
        mac_rule = "00:00:00:00:00:00"
        mac_mask = "00:00:00:00:00:00"
        for p in range(0, packet_count):
            remote_dst_index = p % len(dst_if.remote_hosts)
            remote_dst_host = dst_if.remote_hosts[remote_dst_index]

            dst_port = 1234 + p
            src_port = 4321 + p
            is_permit = self.PERMIT if p % 3 == 0 else self.DENY
            denyMAC = True if not is_permit and p % 3 == 1 else False
            denyIP = True if not is_permit and p % 3 == 2 else False
            if not is_permit and ip_type == self.WILD_IP:
                denyMAC = True
            if not is_permit and mac_type == self.WILD_MAC:
                denyIP = True

            if traffic == self.BRIDGED:
                if is_permit:
                    src_mac = remote_dst_host._mac
                    dst_mac = "de:ad:00:00:00:00"
                    src_ip4 = remote_dst_host.ip4
                    dst_ip4 = src_if.remote_ip4
                    src_ip6 = remote_dst_host.ip6
                    dst_ip6 = src_if.remote_ip6
                    ip_permit = src_ip6 if is_ip6 else src_ip4
                    mac_permit = src_mac
                if denyMAC:
                    mac = src_mac.split(":")
                    mac[0] = format(int(mac[0], 16) + 1, "02x")
                    src_mac = ":".join(mac)
                    if is_ip6:
                        src_ip6 = ip_permit
                    else:
                        src_ip4 = ip_permit
                if denyIP:
                    if ip_type != self.WILD_IP:
                        src_mac = mac_permit
                    src_ip4 = remote_dst_host.ip4
                    dst_ip4 = src_if.remote_ip4
                    src_ip6 = remote_dst_host.ip6
                    dst_ip6 = src_if.remote_ip6
            else:
                if is_permit:
                    src_mac = remote_dst_host._mac
                    dst_mac = src_if.local_mac
                    src_ip4 = src_if.remote_ip4
                    dst_ip4 = remote_dst_host.ip4
                    src_ip6 = src_if.remote_ip6
                    dst_ip6 = remote_dst_host.ip6
                    ip_permit = src_ip6 if is_ip6 else src_ip4
                    mac_permit = src_mac
                if denyMAC:
                    mac = src_mac.split(":")
                    mac[0] = format(int(mac[0], 16) + 1, "02x")
                    src_mac = ":".join(mac)
                    if is_ip6:
                        src_ip6 = ip_permit
                    else:
                        src_ip4 = ip_permit
                if denyIP:
                    src_mac = remote_dst_host._mac
                    if ip_type != self.WILD_IP:
                        src_mac = mac_permit
                    src_ip4 = remote_dst_host.ip4
                    dst_ip4 = src_if.remote_ip4
                    src_ip6 = remote_dst_host.ip6
                    dst_ip6 = src_if.remote_ip6

            if is_permit:
                info = self.create_packet_info(src_if, dst_if)
                payload = self.info_to_payload(info)
            else:
                payload = "to be blocked"

            if mac_type == self.WILD_MAC:
                mac = src_mac.split(":")
                for i in range(1, 5):
                    mac[i] = format(random.randint(0, 255), "02x")
                src_mac = ":".join(mac)

            # create packet
            packet = Ether(src=src_mac, dst=dst_mac)
            ip_rule = src_ip6 if is_ip6 else src_ip4
            if is_ip6:
                if ip_type != self.EXACT_IP:
                    sub_ip = list(unpack("<16B", inet_pton(AF_INET6, ip_rule)))
                    if ip_type == self.WILD_IP:
                        sub_ip[0] = random.randint(240, 254)
                        sub_ip[1] = random.randint(230, 239)
                        sub_ip[14] = random.randint(100, 199)
                        sub_ip[15] = random.randint(200, 255)
                    elif ip_type == self.SUBNET_IP:
                        if denyIP:
                            sub_ip[2] = int(sub_ip[2]) + 1
                        sub_ip[14] = random.randint(100, 199)
                        sub_ip[15] = random.randint(200, 255)
                    packed_src_ip6 = b"".join([scapy.compat.chb(x) for x in sub_ip])
                    src_ip6 = inet_ntop(AF_INET6, packed_src_ip6)
                packet /= IPv6(src=src_ip6, dst=dst_ip6)
            else:
                if ip_type != self.EXACT_IP:
                    sub_ip = ip_rule.split(".")
                    if ip_type == self.WILD_IP:
                        sub_ip[0] = random.randint(1, 49)
                        sub_ip[1] = random.randint(50, 99)
                        sub_ip[2] = random.randint(100, 199)
                        sub_ip[3] = random.randint(200, 255)
                    elif ip_type == self.SUBNET_IP:
                        if denyIP:
                            sub_ip[1] = int(sub_ip[1]) + 1
                        sub_ip[2] = random.randint(100, 199)
                        sub_ip[3] = random.randint(200, 255)
                    src_ip4 = ".".join(["{!s}".format(x) for x in sub_ip])
                packet /= IP(src=src_ip4, dst=dst_ip4, frag=0, flags=0)

            packet /= UDP(sport=src_port, dport=dst_port) / Raw(payload)

            packet[Raw].load += b" mac:%s" % src_mac.encode("utf-8")

            size = self.pg_if_packet_sizes[p % len(self.pg_if_packet_sizes)]
            if isinstance(src_if, VppSubInterface):
                size = size + 4
            if isinstance(src_if, VppDot1QSubint):
                if src_if is self.subifs[0]:
                    if tags == self.PERMIT_TAGS:
                        packet = src_if.add_dot1q_layer(packet, 10)
                    else:
                        packet = src_if<style>
@media only all and (prefers-color-scheme: dark) {
.highlight .hll { background-color: #49483e }
.highlight .c { color: #75715e } /* Comment */
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
.highlight .k { color: #66d9ef } /* Keyword */
.highlight .l { color: #ae81ff } /* Literal */
.highlight .n { color: #f8f8f2 } /* Name */
.highlight .o { color: #f92672 } /* Operator */
.highlight .p { color: #f8f8f2 } /* Punctuation */
.highlight .ch { color: #75715e } /* Comment.Hashbang */
.highlight .cm { color: #75715e } /* Comment.Multiline */
.highlight .cp { color: #75715e } /* Comment.Preproc */
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
.highlight .c1 { color: #75715e } /* Comment.Single */
.highlight .cs { color: #75715e } /* Comment.Special */
.highlight .gd { color: #f92672 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #75715e } /* Generic.Subheading */
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
.highlight .kt { color: #66d9ef } /* Keyword.Type */
.highlight .ld { color: #e6db74 } /* Literal.Date */
.highlight .m { color: #ae81ff } /* Literal.Number */
.highlight .s { color: #e6db74 } /* Literal.String */
.highlight .na { color: #a6e22e } /* Name.Attribute */
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
.highlight .nc { color: #a6e22e } /* Name.Class */
.highlight .no { color: #66d9ef } /* Name.Constant */
.highlight .nd { color: #a6e22e } /* Name.Decorator */
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
.highlight .ne { color: #a6e22e } /* Name.Exception */
.highlight .nf { color: #a6e22e } /* Name.Function */
.highlight .nl { color: #f8f8f2 } /* Name.Label */
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
.highlight .nx { color: #a6e22e } /* Name.Other */
.highlight .py { color: #f8f8f2 } /* Name.Property */
.highlight .nt { color: #f92672 } /* Name.Tag */
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
.highlight .ow { color: #f92672 } /* Operator.Word */
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
.highlight .sa { color: #e6db74 } /* Literal.String.Affix */
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
.highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
}
@media (prefers-color-scheme: light) {
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
}
</style><div class="highlight"><pre><span></span><span class="c1"># Copyright (c) 2021 Cisco and/or its affiliates.</span>
<span class="c1">#</span>
<span class="c1"># SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License 2.0 or</span>
<span class="c1"># GNU General Public License v2.0 or later;  you may not use this file</span>
<span class="c1"># except in compliance with one of these Licenses. You</span>
<span class="c1"># may obtain a copy of the Licenses at:</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html</span>
<span class="c1">#</span>
<span class="c1"># Note: If this file is linked with Scapy, which is GPLv2+, your use of it</span>
<span class="c1"># must be under GPLv2+.  If at any point in the future it is no longer linked</span>
<span class="c1"># with Scapy (or other GPLv2+ licensed software), you are free to choose</span>
<span class="c1"># Apache 2.</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>

<span class="sd">&quot;&quot;&quot;Stream profile for T-rex traffic generator.</span>

<span class="sd">Stream profile:</span>
<span class="sd"> - Two streams sent in directions 0 --&gt; 1 and 1 --&gt; 0 at the same time.</span>
<span class="sd"> - Packet: ETH / IP /</span>
<span class="sd"> - Direction 0 --&gt; 1:</span>
<span class="sd">   - Source IP address range:      10.0.0.1</span>
<span class="sd">   - Destination IP address range: 20.0.0.0 - 20.0.0.39</span>
<span class="sd"> - Direction 1 --&gt; 0:</span>
<span class="sd">   - Source IP address range:      20.0.0.1</span>
<span class="sd">   - Destination IP address range: 10.0.0.0 - 10.0.0.39</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">trex.stl.api</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">profile_trex_stateless_base_class</span> <span class="kn">import</span> <span class="n">TrafficStreamsBaseClass</span>


<span class="k">class</span> <span class="nc">TrafficStreams</span><span class="p">(</span><span class="n">TrafficStreamsBaseClass</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Stream profile.&quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Initialization and setting of streams&#39; parameters.&quot;&quot;&quot;</span>

        <span class="nb">super</span><span class="p">(</span><span class="n">TrafficStreamsBaseClass</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_start_mac</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;02:02:00:00:12:00&quot;</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_start_mac</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;02:02:00:00:02:00&quot;</span>

        <span class="c1"># IPs used in packet headers.</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">p1_src_start_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;10.0.0.1&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_start_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;20.0.0.0&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_end_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;20.0.0.39&quot;</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">p2_src_start_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;20.0.0.1&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_start_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;10.0.0.0&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_end_ip</span> <span class="o">=</span> <span class="sa">u</span><span class="s2">&quot;10.0.0.39&quot;</span>

    <span class="k">def</span> <span class="nf">define_packets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Defines the packets to be sent from the traffic generator.</span>

<span class="sd">        Packet definition: | ETH | IP |</span>

<span class="sd">        :returns: Packets to be sent from the traffic generator.</span>
<span class="sd">        :rtype: tuple</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="c1"># Direction 0 --&gt; 1</span>
        <span class="n">base_pkt_a</span> <span class="o">=</span> <span class="p">(</span>
            <span class="n">Ether</span><span class="p">(</span>
                <span class="n">dst</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_start_mac</span>
            <span class="p">)</span> <span class="o">/</span>
            <span class="n">IP</span><span class="p">(</span>
                <span class="n">src</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p1_src_start_ip</span><span class="p">,</span>
                <span class="n">dst</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_start_ip</span><span class="p">,</span>
                <span class="n">proto</span><span class="o">=</span><span class="mi">61</span>
            <span class="p">)</span>
        <span class="p">)</span>
        <span class="c1"># Direction 1 --&gt; 0</span>
        <span class="n">base_pkt_b</span> <span class="o">=</span> <span class="p">(</span>
            <span class="n">Ether</span><span class="p">(</span>
                <span class="n">dst</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_start_mac</span>
            <span class="p">)</span> <span class="o">/</span>
            <span class="n">IP</span><span class="p">(</span>
                <span class="n">src</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p2_src_start_ip</span><span class="p">,</span>
                <span class="n">dst</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_start_ip</span><span class="p">,</span>
                <span class="n">proto</span><span class="o">=</span><span class="mi">61</span>
            <span class="p">)</span>
        <span class="p">)</span>

        <span class="c1"># Direction 0 --&gt; 1</span>
        <span class="n">vm1</span> <span class="o">=</span> <span class="n">STLScVmRaw</span><span class="p">(</span>
            <span class="p">[</span>
                <span class="n">STLVmFlowVar</span><span class="p">(</span>
                    <span class="n">name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;mac_dst&quot;</span><span class="p">,</span>
                    <span class="n">min_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
                    <span class="n">max_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
                    <span class="n">size</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
                    <span class="n">op</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;inc&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmWrFlowVar</span><span class="p">(</span>
                    <span class="n">fv_name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;mac_dst&quot;</span><span class="p">,</span>
                    <span class="n">pkt_offset</span><span class="o">=</span><span class="mi">5</span>
                <span class="p">),</span>
                <span class="n">STLVmFlowVar</span><span class="p">(</span>
                    <span class="n">name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;dst&quot;</span><span class="p">,</span>
                    <span class="n">min_value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_start_ip</span><span class="p">,</span>
                    <span class="n">max_value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p1_dst_end_ip</span><span class="p">,</span>
                    <span class="n">size</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
                    <span class="n">op</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;inc&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmWrFlowVar</span><span class="p">(</span>
                    <span class="n">fv_name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;dst&quot;</span><span class="p">,</span>
                    <span class="n">pkt_offset</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;IP.dst&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmFixIpv4</span><span class="p">(</span>
                    <span class="n">offset</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;IP&quot;</span>
                <span class="p">)</span>
            <span class="p">]</span>
        <span class="p">)</span>
        <span class="c1"># Direction 1 --&gt; 0</span>
        <span class="n">vm2</span> <span class="o">=</span> <span class="n">STLScVmRaw</span><span class="p">(</span>
            <span class="p">[</span>
                <span class="n">STLVmFlowVar</span><span class="p">(</span>
                    <span class="n">name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;mac_dst&quot;</span><span class="p">,</span>
                    <span class="n">min_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
                    <span class="n">max_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
                    <span class="n">size</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
                    <span class="n">op</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;inc&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmWrFlowVar</span><span class="p">(</span>
                    <span class="n">fv_name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;mac_dst&quot;</span><span class="p">,</span>
                    <span class="n">pkt_offset</span><span class="o">=</span><span class="mi">5</span>
                <span class="p">),</span>
                <span class="n">STLVmFlowVar</span><span class="p">(</span>
                    <span class="n">name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;dst&quot;</span><span class="p">,</span>
                    <span class="n">min_value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_start_ip</span><span class="p">,</span>
                    <span class="n">max_value</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">p2_dst_end_ip</span><span class="p">,</span>
                    <span class="n">size</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
                    <span class="n">op</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;inc&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmWrFlowVar</span><span class="p">(</span>
                    <span class="n">fv_name</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;dst&quot;</span><span class="p">,</span>
                    <span class="n">pkt_offset</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;IP.dst&quot;</span>
                <span class="p">),</span>
                <span class="n">STLVmFixIpv4</span><span class="p">(</span>
                    <span class="n">offset</span><span class="o">=</span><span class="sa">u</span><span class="s2">&quot;IP&quot;</span>
                <span class="p">)</span>
            <span class="p">]</span>
        <span class="p">)</span>

        <span class="k">return</span> <span class="n">base_pkt_a</span><span class="p">,</span> <span class="n">base_pkt_b</span><span class="p">,</span> <span class="n">vm1</span><span class="p">,</span> <span class="n">vm2</span>


<span class="k">def</span> <span class="nf">register</span><span class="p">():</span>
    <span class="sd">&quot;&quot;&quot;Register this traffic profile to T-rex.</span>

<span class="sd">    Do not change this function.</span>

<span class="sd">    :return: Traffic streams.</span>
<span class="sd">    :rtype: Object</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">TrafficStreams</span><span class="p">()</span>
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div id="lfcollabprojects-footer">
  <div class="gray-diagonal">
    <div class="footer-inner">
      <p>
        &copy; 2016 <a href="https://www.fd.io/">FD.io</a> a Linux Foundation
        Collaborative Project. All Rights Reserved.
      </p>
      <p>
        Linux Foundation is a registered trademark of The Linux Foundation.
        Linux is a registered
        <a
          href="http://www.linuxfoundation.org/programs/legal/trademark"
          title="Linux Mark Institute"
          >trademark</a
        >
        of Linus Torvalds.
      </p>
      <p>
        Please see our
        <a href="http://www.linuxfoundation.org/privacy">privacy policy</a> and
        <a href="http://www.linuxfoundation.org/terms">terms of use</a>
      </p>
    </div>
  </div>
</div>
</div> <!-- id=cgit -->
</body>
</html>
  self.assertEqual(reply.acls[sw_if_index1], 0)
        self.assertEqual(reply.acls[sw_if_index2], 1)
        self.assertEqual(reply.acls[sw_if_index3], 1)
        self.logger.info("MACIP ACL on multiple interfaces:")
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip acl"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip acl index 1234"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip acl index 1"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip acl index 0"))
        self.logger.info(self.vapi.ppcli("sh acl-plugin macip interface"))

        intf[2].remove_vpp_config()
        intf[1].remove_vpp_config()

        reply = self.vapi.macip_acl_interface_get()
        self.assertEqual(reply.count, intf_count + 3)
        self.assertEqual(reply.acls[sw_if_index0], 4294967295)
        self.assertEqual(reply.acls[sw_if_index1], 4294967295)
        self.assertEqual(reply.acls[sw_if_index2], 4294967295)
        self.assertEqual(reply.acls[sw_if_index3], 1)

        intf[3].remove_vpp_config()
        reply = self.vapi.macip_acl_interface_get()

        self.assertEqual(len([x for x in reply.acls if x != 4294967295]), 0)


class TestACL_dot1q_bridged(MethodHolder):
    """ACL on dot1q bridged subinterfaces Tests"""

    @classmethod
    def setUpClass(cls):
        super(TestACL_dot1q_bridged, cls).setUpClass()

    @classmethod
    def tearDownClass(cls):
        super(TestACL_dot1q_bridged, cls).tearDownClass()

    def test_acl_bridged_ip4_subif_dot1q(self):
        """IP4 ACL SubIf Dot1Q bridged traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.BRIDGED,
            self.IS_IP4,
            9,
            tags=self.DOT1Q,
            isMACIP=False,
        )

    def test_acl_bridged_ip6_subif_dot1q(self):
        """IP6 ACL SubIf Dot1Q bridged traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.BRIDGED,
            self.IS_IP6,
            9,
            tags=self.DOT1Q,
            isMACIP=False,
        )


class TestACL_dot1ad_bridged(MethodHolder):
    """ACL on dot1ad bridged subinterfaces Tests"""

    @classmethod
    def setUpClass(cls):
        super(TestACL_dot1ad_bridged, cls).setUpClass()

    @classmethod
    def tearDownClass(cls):
        super(TestACL_dot1ad_bridged, cls).tearDownClass()

    def test_acl_bridged_ip4_subif_dot1ad(self):
        """IP4 ACL SubIf Dot1AD bridged traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.BRIDGED,
            self.IS_IP4,
            9,
            tags=self.DOT1AD,
            isMACIP=False,
        )

    def test_acl_bridged_ip6_subif_dot1ad(self):
        """IP6 ACL SubIf Dot1AD bridged traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.BRIDGED,
            self.IS_IP6,
            9,
            tags=self.DOT1AD,
            isMACIP=False,
        )


class TestACL_dot1q_routed(MethodHolder):
    """ACL on dot1q routed subinterfaces Tests"""

    @classmethod
    def setUpClass(cls):
        super(TestACL_dot1q_routed, cls).setUpClass()

    @classmethod
    def tearDownClass(cls):
        super(TestACL_dot1q_routed, cls).tearDownClass()

    def test_acl_routed_ip4_subif_dot1q(self):
        """IP4 ACL SubIf Dot1Q routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP4,
            9,
            tags=self.DOT1Q,
            isMACIP=False,
        )

    def test_acl_routed_ip6_subif_dot1q(self):
        """IP6 ACL SubIf Dot1Q routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP6,
            9,
            tags=self.DOT1Q,
            isMACIP=False,
        )

    def test_acl_routed_ip4_subif_dot1q_deny_by_tags(self):
        """IP4 ACL SubIf wrong tags Dot1Q routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP4,
            9,
            True,
            tags=self.DOT1Q,
            isMACIP=False,
            permit_tags=self.DENY_TAGS,
        )

    def test_acl_routed_ip6_subif_dot1q_deny_by_tags(self):
        """IP6 ACL SubIf wrong tags Dot1Q routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP6,
            9,
            True,
            tags=self.DOT1Q,
            isMACIP=False,
            permit_tags=self.DENY_TAGS,
        )


class TestACL_dot1ad_routed(MethodHolder):
    """ACL on dot1ad routed subinterfaces Tests"""

    @classmethod
    def setUpClass(cls):
        super(TestACL_dot1ad_routed, cls).setUpClass()

    @classmethod
    def tearDownClass(cls):
        super(TestACL_dot1ad_routed, cls).tearDownClass()

    def test_acl_routed_ip6_subif_dot1ad(self):
        """IP6 ACL SubIf Dot1AD routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP6,
            9,
            tags=self.DOT1AD,
            isMACIP=False,
        )

    def test_acl_routed_ip4_subif_dot1ad(self):
        """IP4 ACL SubIf Dot1AD routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP4,
            9,
            tags=self.DOT1AD,
            isMACIP=False,
        )

    def test_acl_routed_ip6_subif_dot1ad_deny_by_tags(self):
        """IP6 ACL SubIf wrong tags Dot1AD routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP6,
            9,
            True,
            tags=self.DOT1AD,
            isMACIP=False,
            permit_tags=self.DENY_TAGS,
        )

    def test_acl_routed_ip4_subif_dot1ad_deny_by_tags(self):
        """IP4 ACL SubIf wrong tags Dot1AD routed traffic"""
        self.run_traffic(
            self.EXACT_MAC,
            self.EXACT_IP,
            self.ROUTED,
            self.IS_IP4,
            9,
            True,
            tags=self.DOT1AD,
            isMACIP=False,
            permit_tags=self.DENY_TAGS,
        )


if __name__ == "__main__":
    unittest.main(testRunner=VppTestRunner)