1 # Copyright (c) 2021 Cisco and/or its affiliates.
3 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
5 # Licensed under the Apache License 2.0 or
6 # GNU General Public License v2.0 or later; you may not use this file
7 # except in compliance with one of these Licenses. You
8 # may obtain a copy of the Licenses at:
10 # http://www.apache.org/licenses/LICENSE-2.0
11 # https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
13 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
14 # must be under GPLv2+. If at any point in the future it is no longer linked
15 # with Scapy (or other GPLv2+ licensed software), you are free to choose
18 # Unless required by applicable law or agreed to in writing, software
19 # distributed under the License is distributed on an "AS IS" BASIS,
20 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 # See the License for the specific language governing permissions and
22 # limitations under the License.
24 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
27 - Two streams sent in directions 0 --> 1 (client -> server, requests) and
28 1 --> 0 (server -> client, responses) at the same time.
29 - Packet: ETH / IP / TCP
31 - Source IP address range: 192.168.0.0 - 192.168.15.255
32 - Destination IP address range: 20.0.0.0 - 20.0.15.255
34 - Source IP address range: destination IP address from packet received
36 - Destination IP address range: source IP address from packet received
39 This is a profile for CPS tests, it only sets up and tears down TCP session.
40 No delays, no data transfer.
43 from trex.astf.api import *
44 from profile_trex_astf_base_class import TrafficProfileBaseClass
47 class TrafficProfile(TrafficProfileBaseClass):
48 """Traffic profile."""
50 def __init__(self, **kwargs):
51 """Initialization and setting of profile parameters."""
53 super(TrafficProfileBaseClass, self).__init__()
55 # IPs used in packet headers.
56 self.p1_src_start_ip = u"192.168.0.0"
57 self.p1_src_end_ip = u"192.168.15.255"
58 self.p1_dst_start_ip = u"20.0.0.0"
59 self.p1_dst_end_ip = u"20.0.15.255"
61 # Headers length; not used in this profile, just for the record of
62 # header length for TCP packet with 0B payload
63 self.headers_size = 58 # 14B l2 + 20B ipv4 + 24B tcp incl. 4B options
65 def define_profile(self):
66 """Define profile to be used by advanced stateful traffic generator.
68 This method MUST return:
70 return ip_gen, templates, None
72 :returns: IP generator and profile templates for ASTFProfile().
76 prog_c = ASTFProgram()
79 # receive syn-ack (0B sent in tcp syn-ack packet) and send ack
83 prog_s = ASTFProgram()
84 # receive syn, send syn-ack
86 # receive fin-ack, send ack + fin-ack
87 prog_s.wait_for_peer_close()
90 ip_gen_c = ASTFIPGenDist(
91 ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
94 ip_gen_s = ASTFIPGenDist(
95 ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
99 glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
100 dist_client=ip_gen_c,
105 s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
108 temp_c = ASTFTCPClientTemplate(
111 limit=258048, # TODO: set via input parameter
114 temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
115 template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
117 return ip_gen, template, None
121 """Register this traffic profile to T-Rex.
123 Do not change this function.
125 :return: Traffic Profiles.
128 return TrafficProfile()