src/plugins/snort

# Copyright (c) 2020 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:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Stream profile for T-rex traffic generator.

Stream profile:
 - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
 - Packet: ETH / IP /
 - Direction 0 --> 1:
   - Destination MAC address: 52:54:00:00:nf_id:01
   - Source IP address range:      10.10.10.1 - 10.10.10.254
   - Destination IP address range: 20.20.20.1
 - Direction 1 --> 0:
   - Destination MAC address: 52:54:00:00:nf_id:02
   - Source IP address range:      20.20.20.1 - 20.20.20.254
   - Destination IP address range: 10.10.10.1
"""

from trex.stl.api import *
from profile_trex_stateless_base_class import TrafficStreamsBaseClass


class TrafficStreams(TrafficStreamsBaseClass):
    """Stream profile."""

    def __init__(self):
        """Initialization and setting of streams' parameters."""

        super(TrafficStreamsBaseClass, self).__init__()

        # Service density parameters.
        self.nf_chains = 10
        self.nf_nodes = 1

        # MACs used in packet headers.
        self.p1_dst_start_mac = u"52:54:00:00:00:01"
        self.p2_dst_start_mac = u"52:54:00:00:00:02"

        # IPs used in packet headers.
        self.p1_src_start_ip = u"10.10.10.1"
        self.p1_src_end_ip = u"10.10.10.254"
        self.p1_dst_start_ip = u"20.20.20.1"

        self.p2_src_start_ip = u"20.20.20.1"
        self.p2_src_end_ip = u"20.20.20.254"
        self.p2_dst_start_ip = u"10.10.10.1"

    def define_packets(self):
        """Defines the packets to be sent from the traffic generator.

        Packet definition: | ETH | IP |

        :returns: Packets to be sent from the traffic generator.
        :rtype: tuple
        """

        # Direction 0 --> 1
        base_pkt_a = (
            Ether(
                dst=self.p1_dst_start_mac
            ) /
            IP(
                src=self.p1_src_start_ip,
                dst=self.p1_dst_start_ip,
                proto=61
            )
        )
        # Direction 1 --> 0
        base_pkt_b = (
            Ether(
                dst=self.p2_dst_start_mac
            ) /
            IP(
                src=self.p2_src_start_ip,
                dst=self.p2_dst_start_ip,
                proto=61
            )
        )

        # Direction 0 --> 1
        vm1 = STLScVmRaw(
            [
                STLVmFlowVar(
                    name=u"mac_dst",
                    min_value=1,
                    max_value=self.nf_chains*self.nf_nodes,
                    size=1,
                    step=self.nf_nodes,
                    op=u"inc"
                ),
                STLVmWrFlowVar(
                    fv_name=u"mac_dst",
                    pkt_offset=4
                ),
                STLVmFlowVar(
                    name=u"src",
                    min_value=self.p1_src_start_ip,
                    max_value=self.p1_src_end_ip,
                    size=4, op=u"inc"
                ),
                STLVmWrFlowVar(
                    fv_name=u"src",
                    pkt_offset=u"IP.src"
                ),
                STLVmFixIpv4(
                    offset=u"IP"
                )
            ]
        )
        # Direction 1 --> 0
        vm2 = STLScVmRaw(
            [
                STLVmFlowVar(
                    name=u"mac_dst",
                    min_value=self.nf_nodes,
                    max_value=self.nf_chains*self.nf_nodes,
                    size=1,
                    step=self.nf_nodes,
                    op=u"inc"
                ),
                STLVmWrFlowVar(
                    fv_name=u"mac_dst",
                    pkt_offset=4
                ),
                STLVmFlowVar(
                    name=u"src",
                    min_value=self.p2_src_start_ip,
                    max_value=self.p2_src_end_ip,
                    size=4,
                    op=u"inc"
                ),
                STLVmWrFlowVar(
                    fv_name=u"src",
                    pkt_offset=u"IP.src"
                ),
                STLVmFixIpv4(
                    offset=u"IP"
                )
            ]
        )

        return base_pkt_a, base_pkt_b, vm1, vm2


def register():
    """Register this traffic profile to T-rex.

    Do not change this function.

    :return: Traffic streams.
    :rtype: Object
    """
    return TrafficStreams()
Age	Commit message (Expand)	Author	Files	Lines
2023-11-03	vppinfra: refactor interrupt code	Damjan Marion	1	-2/+2
2023-03-06	snort: fix descriptor offset may be truncated if buffers num too large	jiangxiaoming	1	-1/+1
2023-02-06	vppinfra: refactor clib_socket_init, add linux netns support	Damjan Marion	1	-2/+4
2022-04-04	vppinfra: make _vec_len() read-only	Damjan Marion	1	-1/+1
2022-01-30	snort: feature support on interface output	Sivaprasad Tummala	4	-12/+64
2021-11-22	snort: fix coverity warning	Klement Sekera	1	-2/+11
2021-11-22	snort: fix coverity warning	Klement Sekera	1	-2/+2
2021-11-05	snort: default logging level should not be debug	Damjan Marion	1	-1/+0
2021-11-05	snort: fix unused result warning for gcc-10	Tianyu Li	1	-2/+1
2021-11-02	snort: fix inconsistent snort input mode	Sivaprasad Tummala	1	-1/+2
2021-09-13	snort: fix epoll_wait unsigned return value	Tianyu Li	1	-3/+9
2021-08-27	snort: fix incorrect data length for snort inspection	Sivaprasad Tummala	1	-0/+1
2021-08-27	snort: fix snort hang issue when interrupted	Sivaprasad Tummala	1	-1/+20
2021-07-16	snort: snort3 plugin and DAQ	Damjan Marion	8	-0/+2326