diff options
Diffstat (limited to 'resources')
| -rw-r--r-- | resources/libraries/python/telemetry/IPFIXSetup.py | 129 | ||||
| -rw-r--r-- | resources/libraries/python/telemetry/IPFIXUtil.py | 105 | ||||
| -rw-r--r-- | resources/libraries/python/telemetry/SPAN.py | 48 | ||||
| -rw-r--r-- | resources/libraries/robot/telemetry/ipfix.robot | 111 | ||||
| -rw-r--r-- | resources/libraries/robot/telemetry/span.robot | 4 | ||||
| -rw-r--r-- | resources/templates/vat/ipfix_exporter_set.vat | 1 | ||||
| -rw-r--r-- | resources/templates/vat/ipfix_interface_enable.vat | 1 | ||||
| -rw-r--r-- | resources/templates/vat/ipfix_stream_set.vat | 1 | ||||
| -rw-r--r-- | resources/templates/vat/ipfix_table_add.vat | 1 | ||||
| -rw-r--r-- | resources/templates/vat/span_create.vat | 1 | ||||
| -rw-r--r-- | resources/templates/vat/span_dump.vat | 1 | ||||
| -rwxr-xr-x | resources/traffic_scripts/ipfix_check.py | 195 | ||||
| -rwxr-xr-x | resources/traffic_scripts/ipfix_sessions.py | 229 |
13 files changed, 22 insertions, 805 deletions
diff --git a/resources/libraries/python/telemetry/IPFIXSetup.py b/resources/libraries/python/telemetry/IPFIXSetup.py deleted file mode 100644 index db703c8a7e..0000000000 --- a/resources/libraries/python/telemetry/IPFIXSetup.py +++ /dev/null @@ -1,129 +0,0 @@ -# Copyright (c) 2018 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. - -"""IPFIX setup library""" - -from resources.libraries.python.topology import Topology -from resources.libraries.python.VatExecutor import VatTerminal - - -class IPFIXSetup(object): - """Class contains methods for seting up IPFIX reporting on DUTs.""" - - def __init__(self): - """Initializer.""" - pass - - @staticmethod - def setup_ipfix_exporter(node, collector, source, fib=None, mtu=None, - interval=None): - """Setup an IPFIX exporter on node to export collected flow data. - - :param node: DUT node. - :param collector: IP address of flow data collector. - :param source: IP address of local interface to send flow data from. - :param fib: fib table ID. - :param mtu: Maximum transfer unit of path to collector. - :param interval: Frequency of sending template packets, in seconds. - :type node: dict - :type collector: str - :type source: str - :type fib: int - :type mtu: int - :type interval: int - """ - - fib = "vrf_id {0}".format(fib) if fib else '' - mtu = "path_mtu {0}".format(mtu) if mtu else '' - interval = "template_interval {0}".format(interval) if interval else '' - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template('ipfix_exporter_set.vat', - collector=collector, - source=source, - fib=fib, - mtu=mtu, - interval=interval) - - @staticmethod - def assign_interface_to_flow_table(node, interface, table_id, - ip_version='ip4'): - """Assigns a VPP interface to the specified classify table for IPFIX - flow data collection. - - :param node: DUT node. - :param interface: An interface on the DUT node. - :param table_id: ID of a classify table. - :param ip_version: Version of IP protocol. Valid options are ip4, ip6. - :type node: dict - :type interface: str or int - :type table_id: int - :type ip_version: str - """ - - if isinstance(interface, basestring): - sw_if_index = Topology.get_interface_sw_index(node, interface) - elif isinstance(interface, int): - sw_if_index = interface - else: - raise TypeError - - table = "{0}-table {1}".format(ip_version, table_id) - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template( - "ipfix_interface_enable.vat", - interface=sw_if_index, - table=table, - delete='') - - @staticmethod - def set_ipfix_stream(node, domain=None, src_port=None): - """Set an IPFIX export stream. Can be used to break up IPFIX reports - into separate reporting domains. - - :param node: DUT node. - :param domain: Desired index number of exporting domain. - :param src_port: Source port to use when sending IPFIX packets. Default - is the standard IPFIX port 4739. - :type node: dict - :type domain: int - :type src_port: int - """ - - domain = "domain {0}".format(domain) if domain else '' - src_port = "src_port {0}".format(src_port) if src_port else '' - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template("ipfix_stream_set.vat", - domain=domain, - src_port=src_port) - - @staticmethod - def assign_classify_table_to_exporter(node, table_id, ip_version='ip4'): - """Assign a classify table to an IPFIX exporter. Classified packets will - be included in the IPFIX flow report. - - :param node: DUT node. - :param table_id: ID of a classify table. - :param ip_version: Version of IP protocol. Valid options are ip4, ip6. - :type node: dict - :type table_id: int - :type ip_version: str - """ - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template("ipfix_table_add.vat", - table=table_id, - ip_version=ip_version, - add_del='add') diff --git a/resources/libraries/python/telemetry/IPFIXUtil.py b/resources/libraries/python/telemetry/IPFIXUtil.py deleted file mode 100644 index 2f83760759..0000000000 --- a/resources/libraries/python/telemetry/IPFIXUtil.py +++ /dev/null @@ -1,105 +0,0 @@ -# Copyright (c) 2016 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. - -"""IPFIX utilities library. Provides classes that allow scapy to work -with IPFIX packets. - - Note: - Template and data sets in one packet are not supported. - Option template sets (Set_ID = 3) are not supported. - """ - - -from scapy.all import Packet, bind_layers -from scapy.fields import ByteField, ShortField, IntField, LongField, IPField,\ - StrFixedLenField, FieldListField -from scapy.layers.inet import UDP -from scapy.layers.inet6 import IP6Field -from scapy.contrib.ppi_geotag import UTCTimeField - - -class IPFIXHandler(object): - """Class for handling IPFIX packets. To use, create instance of class before - dissecting IPFIX packets with scapy, then run update_template every time - an IPFIX template packet is received.""" - - template_elements = { - 4: ByteField("Protocol_ID", 0x00), - 7: ShortField("src_port", 0), - 8: IPField("IPv4_src", ""), - 11: ShortField("dst_port", 0), - 12: IPField("IPv4_dst", ""), - 27: IP6Field("IPv6_src", "::"), - 28: IP6Field("IPv6_dst", "::"), - 86: LongField("packetTotalCount", 0), - 180: ShortField("udp_src_port", 0), - 181: ShortField("udp_dst_port", 0), - 182: ShortField("tcp_src_port", 0), - 183: ShortField("tcp_dst_port", 0), - 193: ByteField("Next_header", 0x00) - } - - def __init__(self): - """Initializer, registers IPFIX header and template layers with scapy. - """ - bind_layers(UDP, IPFIXHeader, dport=4739) - bind_layers(IPFIXHeader, IPFIXTemplate, Set_ID=2) - - def update_template(self, packet): - """Updates IPFIXData class with new data template. Registers IPFIX data - layer with scapy using the new template. - - :param packet: Packet containing an IPFIX template. - :type packet: scapy.Ether - """ - template_list = packet['IPFIX template'].Template - template_id = packet['IPFIX template'].Template_ID - - IPFIXData.fields_desc = [] - for item in template_list[::2]: - try: - IPFIXData.fields_desc.append(self.template_elements[item]) - except KeyError: - raise KeyError( - "Unknown IPFIX template element with ID {0}".format(item)) - bind_layers(IPFIXHeader, IPFIXData, Set_ID=template_id) - # if the packet doesn't end here, assume it contains more data sets - bind_layers(IPFIXData, IPFIXData) - - -class IPFIXHeader(Packet): - """Class for IPFIX header.""" - name = "IPFIX header" - fields_desc = [StrFixedLenField("Version", 0x000a, length=2), - ShortField("Message Length", 0), - UTCTimeField("Timestamp(UTC)", ""), - IntField("Sequence Number", 0), - IntField("Observation Domain ID", 0), - ShortField("Set_ID", 0), - ShortField("Set_Length", 0)] - - -class IPFIXTemplate(Packet): - """Class for IPFIX template layer.""" - name = "IPFIX template" - fields_desc = [ShortField("Template_ID", 256), - ShortField("nFields", 2), - FieldListField("Template", [], ShortField("type_len", ""), - count_from=lambda p: p.nFields*2)] - - -class IPFIXData(Packet): - """Class for IPFIX data layer. Needs to be updated with - a template before use.""" - name = "IPFIX flow data" - fields_desc = [] diff --git a/resources/libraries/python/telemetry/SPAN.py b/resources/libraries/python/telemetry/SPAN.py index 048e89ba67..c282c6160b 100644 --- a/resources/libraries/python/telemetry/SPAN.py +++ b/resources/libraries/python/telemetry/SPAN.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 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: @@ -14,7 +14,7 @@ """SPAN setup library""" from resources.libraries.python.topology import Topology -from resources.libraries.python.VatExecutor import VatTerminal +from resources.libraries.python.PapiExecutor import PapiExecutor class SPAN(object): @@ -25,39 +25,26 @@ class SPAN(object): pass @staticmethod - def set_span_mirroring(node, src_if, dst_if): - """Set Span mirroring on the specified node. - - :param node: DUT node. - :param src_if: Interface to mirror traffic from. - :param dst_if: Interface to mirror traffic to. - :type node: dict - :type src_if: str - :type dst_if: str - """ - - src_if = Topology.get_interface_sw_index(node, src_if) - dst_if = Topology.get_interface_sw_index(node, dst_if) - - with VatTerminal(node, json_param=False) as vat: - vat.vat_terminal_exec_cmd_from_template('span_create.vat', - src_sw_if_index=src_if, - dst_sw_if_index=dst_if) - - @staticmethod - def vpp_get_span_configuration(node): + def vpp_get_span_configuration(node, is_l2=False): """Get full SPAN configuration from VPP node. + Used by Honeycomb. + :param node: DUT node. :type node: dict + :returns: Full SPAN configuration as list. One list entry for every source/destination interface pair. :rtype: list of dict """ + args = dict( + is_l2=1 if is_l2 else 0 + ) + with PapiExecutor(node) as papi_exec: + dump = papi_exec.add("sw_interface_span_dump", **args). \ + get_dump().reply[0]["api_reply"] - with VatTerminal(node, json_param=True) as vat: - data = vat.vat_terminal_exec_cmd_from_template('span_dump.vat') - return data[0] + return dump @staticmethod def vpp_get_span_configuration_by_interface(node, dst_interface, @@ -65,6 +52,8 @@ class SPAN(object): """Get a list of all interfaces currently being mirrored to the specified interface. + Used by Honeycomb. + :param node: DUT node. :param dst_interface: Name, sw_if_index or key of interface. :param ret_format: Optional. Desired format of returned interfaces. @@ -78,12 +67,13 @@ class SPAN(object): data = SPAN.vpp_get_span_configuration(node) - dst_interface = Topology.convert_interface_reference( + dst_int = Topology.convert_interface_reference( node, dst_interface, "sw_if_index") src_interfaces = [] for item in data: - if item["dst-if-index"] == dst_interface: - src_interfaces.append(item["src-if-index"]) + if item["sw_interface_span_details"]["sw_if_index_to"] == dst_int: + src_interfaces.append( + item["sw_interface_span_details"]["sw_if_index_from"]) if ret_format != "sw_if_index": src_interfaces = [ diff --git a/resources/libraries/robot/telemetry/ipfix.robot b/resources/libraries/robot/telemetry/ipfix.robot deleted file mode 100644 index b7d8ac74f9..0000000000 --- a/resources/libraries/robot/telemetry/ipfix.robot +++ /dev/null @@ -1,111 +0,0 @@ -# Copyright (c) 2016 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. - -"""IPFIX keywords""" - -*** Settings *** -| Library | resources.libraries.python.TrafficScriptExecutor -| Library | resources.libraries.python.InterfaceUtil -| Resource | resources/libraries/robot/shared/default.robot -| Documentation | Traffic keywords - -*** Keywords *** -| Send packets and verify IPFIX -| | [Documentation] | Send simple TCP or UDP packets from source interface\ -| | ... | to destination interface. Listen for IPFIX flow report on source\ -| | ... | interface and verify received report against number of packets sent. -| | ... -| | ... | *Arguments:* -| | ... -| | ... | - tg_node - TG node. Type: dictionary -| | ... | - dst_node - Destination node. Type: dictionary -| | ... | - src_int - Source interface. Type: string -| | ... | - dst_int - Destination interface. Type: string -| | ... | - src_ip - Source IP address. Type: string -| | ... | - dst_ip - Destination IP address. Type: string -| | ... | - protocol - TCP or UDP (Optional, default is TCP). Type: string -| | ... | - port - Source and destination ports to use -| | ... | (Optional, default is port 20). Type: integer -| | ... | - count - Number of packets to send -| | ... | (Optional, default is one packet). Type: integer -| | ... | - timeout - Timeout value in seconds (Optional, default is 10 sec). -| | ... | Should be at least twice the configured IPFIX flow report interval. -| | ... | Type: integer -| | ... -| | ... | *Return:* -| | ... -| | ... | - No value returned -| | ... -| | ... | *Example:* -| | ... -| | ... | \| Send packets and verify IPFIX \| ${nodes['TG']} | ${nodes['DUT1']}\ -| | ... | \| eth1 \| GigabitEthernet0/8/0 \| 16.0.0.1 \| 192.168.0.2 \| UDP \ -| | ... | \| ${20} \| ${5} \| ${10} \| -| | ... | -| | [Arguments] | ${tg_node} | ${dst_node} | ${src_int} | ${dst_int} | -| | ... | ${src_ip} | ${dst_ip} | ${protocol}=tcp | ${port}=20 | ${count}=1 -| | ... | ${timeout}=${10} -| | ${src_mac}= | Get Interface Mac | ${tg_node} | ${src_int} -| | ${dst_mac}= | Get Interface Mac | ${dst_node} | ${dst_int} -| | ${src_int_name}= | Get interface name | ${tg_node} | ${src_int} -| | ${dst_int_name}= | Get interface name | ${dst_node} | ${dst_int} -| | ${args}= | Traffic Script Gen Arg | ${dst_int_name} | ${src_int_name} -| | ... | ${src_mac} | ${dst_mac} | ${src_ip} | ${dst_ip} -| | ${args}= | Set Variable -| | ... | ${args} --protocol ${protocol} --port ${port} --count ${count} -| | Run Traffic Script On Node | ipfix_check.py | ${tg_node} | ${args} -| | ... | ${timeout} - -| Send session sweep and verify IPFIX -| | [Documentation] | Send simple TCP or UDP packets from source interface\ -| | ... | to destination interface using a range of source addresses. Listen\ -| | ... | for IPFIX flow report on source interface and verify received report\ -| | ... | against number of packets sent from each source address. -| | ... -| | ... | *Arguments:* -| | ... -| | ... | - tg_node - TG node. Type: dictionary -| | ... | - dst_node - Destination node. Type: dictionary -| | ... | - src_int - Source interface. Type: string -| | ... | - dst_int - Destination interface. Type: string -| | ... | - src_ip - Source IP address. Type: string -| | ... | - dst_ip - Destination IP address. Type: string -| | ... | - ip_range - Number of sequential source addresses. Type:integer -| | ... | - protocol - TCP or UDP (Optional, defaults to TCP). Type: string -| | ... | - port - Source and destination ports to use (Optional). Type: integer -| | ... | - count - Number of packets to send (Optional). Type: integer -| | ... | - timeout - Timeout value in seconds (optional). Type:integer -| | ... -| | ... | *Return:* -| | ... -| | ... | - No value returned -| | ... -| | ... | *Example:* -| | ... -| | ... | \| Send packets and verify IPFIX \| ${nodes['TG']} | ${nodes['DUT1']}\ -| | ... | \| eth1 \| GigabitEthernet0/8/0 \| 16.0.0.1 \| 192.168.0.2 \| 20 \| -| | ... | UDP \| ${20} \| ${5} \| ${10} \| -| | ... | -| | [Arguments] | ${tg_node} | ${dst_node} | ${src_int} | ${dst_int} | -| | ... | ${src_ip} | ${dst_ip} | ${ip_range} | ${protocol}=tcp | ${port}=20 -| | ... | ${count}=${1} | ${timeout}=${10} -| | ${src_mac}= | Get Interface Mac | ${tg_node} | ${src_int} -| | ${dst_mac}= | Set Variable | ${dut1_to_tg_mac} -| | ${src_int_name}= | Get interface name | ${tg_node} | ${src_int} -| | ${dst_int_name}= | Get interface name | ${dst_node} | ${dst_int} -| | ${args}= | Traffic Script Gen Arg | ${dst_int_name} | ${src_int_name} -| | ... | ${src_mac} | ${dst_mac} | ${src_ip} | ${dst_ip} -| | ${args}= | Set Variable | ${args} --protocol ${protocol} --port ${port} -| | ${args}= | Set Variable | ${args} --count ${count} --sessions ${ip_range} -| | Run Traffic Script On Node | ipfix_sessions.py | ${tg_node} | ${args} -| | ... | ${timeout}
\ No newline at end of file diff --git a/resources/libraries/robot/telemetry/span.robot b/resources/libraries/robot/telemetry/span.robot index 3ef8716cfa..3d725bbbf7 100644 --- a/resources/libraries/robot/telemetry/span.robot +++ b/resources/libraries/robot/telemetry/span.robot @@ -1,4 +1,4 @@ -# 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: @@ -22,6 +22,8 @@ | | ... | link, then receive a copy of both the sent packet and the DUT's reply\ | | ... | on the second link. | | ... +| | ... | Used by Honeycomb. +| | ... | | ... | *Arguments:* | | ... | | ... | - tg_node - Node to execute scripts on (TG). Type: dictionary diff --git a/resources/templates/vat/ipfix_exporter_set.vat b/resources/templates/vat/ipfix_exporter_set.vat deleted file mode 100644 index 9217375e01..0000000000 --- a/resources/templates/vat/ipfix_exporter_set.vat +++ /dev/null @@ -1 +0,0 @@ -set_ipfix_exporter collector_address {collector} src_address {source} {fib} {mtu} {interval}
\ No newline at end of file diff --git a/resources/templates/vat/ipfix_interface_enable.vat b/resources/templates/vat/ipfix_interface_enable.vat deleted file mode 100644 index 5432a6916a..0000000000 --- a/resources/templates/vat/ipfix_interface_enable.vat +++ /dev/null @@ -1 +0,0 @@ -flow_classify_set_interface sw_if_index {interface} {table} {delete}
\ No newline at end of file diff --git a/resources/templates/vat/ipfix_stream_set.vat b/resources/templates/vat/ipfix_stream_set.vat deleted file mode 100644 index 97d84beb1c..0000000000 --- a/resources/templates/vat/ipfix_stream_set.vat +++ /dev/null @@ -1 +0,0 @@ -set_ipfix_classify_stream {domain} {src_port}
\ No newline at end of file diff --git a/resources/templates/vat/ipfix_table_add.vat b/resources/templates/vat/ipfix_table_add.vat deleted file mode 100644 index 87b0cc169d..0000000000 --- a/resources/templates/vat/ipfix_table_add.vat +++ /dev/null @@ -1 +0,0 @@ -ipfix_classify_table_add_del table {table} {ip_version} {add_del}
\ No newline at end of file diff --git a/resources/templates/vat/span_create.vat b/resources/templates/vat/span_create.vat deleted file mode 100644 index 3671d0b19e..0000000000 --- a/resources/templates/vat/span_create.vat +++ /dev/null @@ -1 +0,0 @@ -sw_interface_span_enable_disable src_sw_if_index {src_sw_if_index} dst_sw_if_index {dst_sw_if_index} diff --git a/resources/templates/vat/span_dump.vat b/resources/templates/vat/span_dump.vat deleted file mode 100644 index 0f83af73c3..0000000000 --- a/resources/templates/vat/span_dump.vat +++ /dev/null @@ -1 +0,0 @@ -sw_interface_span_dump
\ No newline at end of file diff --git a/resources/traffic_scripts/ipfix_check.py b/resources/traffic_scripts/ipfix_check.py deleted file mode 100755 index f5693cc7e8..0000000000 --- a/resources/traffic_scripts/ipfix_check.py +++ /dev/null @@ -1,195 +0,0 @@ -#!/usr/bin/env python - -# Copyright (c) 2016 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. - -"""Traffic script - IPFIX listener.""" - -import sys - -from ipaddress import IPv4Address, IPv6Address, AddressValueError -from scapy.layers.inet import IP, TCP, UDP -from scapy.layers.inet6 import IPv6 -from scapy.layers.l2 import Ether - -from resources.libraries.python.PacketVerifier import RxQueue, TxQueue, auto_pad -from resources.libraries.python.TrafficScriptArg import TrafficScriptArg -from resources.libraries.python.telemetry.IPFIXUtil import IPFIXHandler -from resources.libraries.python.telemetry.IPFIXUtil import IPFIXData - - -def valid_ipv4(ip): - """Check if IP address has the correct IPv4 address format. - - :param ip: IP address. - :type ip: str - :return: True in case of correct IPv4 address format, - otherwise return false. - :rtype: bool - """ - try: - IPv4Address(unicode(ip)) - return True - except (AttributeError, AddressValueError): - return False - - -def valid_ipv6(ip): - """Check if IP address has the correct IPv6 address format. - - :param ip: IP address. - :type ip: str - :return: True in case of correct IPv6 address format, - otherwise return false. - :rtype: bool - """ - try: - IPv6Address(unicode(ip)) - return True - except (AttributeError, AddressValueError): - return False - - -def main(): - """Send packets to VPP, then listen for IPFIX flow report. Verify that - the correct packet count was reported.""" - args = TrafficScriptArg( - ['src_mac', 'dst_mac', 'src_ip', 'dst_ip', 'protocol', 'port', 'count'] - ) - - dst_mac = args.get_arg('dst_mac') - src_mac = args.get_arg('src_mac') - src_ip = args.get_arg('src_ip') - dst_ip = args.get_arg('dst_ip') - tx_if = args.get_arg('tx_if') - - protocol = args.get_arg('protocol') - source_port = int(args.get_arg('port')) - destination_port = int(args.get_arg('port')) - count = int(args.get_arg('count')) - - txq = TxQueue(tx_if) - rxq = RxQueue(tx_if) - - # generate simple packet based on arguments - if valid_ipv4(src_ip) and valid_ipv4(dst_ip): - ip_version = IP - elif valid_ipv6(src_ip) and valid_ipv6(dst_ip): - ip_version = IPv6 - else: - raise ValueError("Invalid IP version!") - - if protocol.upper() == 'TCP': - protocol = TCP - elif protocol.upper() == 'UDP': - protocol = UDP - else: - raise ValueError("Invalid type of protocol!") - - pkt_raw = (Ether(src=src_mac, dst=dst_mac) / - ip_version(src=src_ip, dst=dst_ip) / - protocol(sport=int(source_port), - dport=int(destination_port))) - - # do not print details for sent packets when sending more than one - if count > 1: - verbose = False - print("Sending more than one packet. Details will be filtered for " - "all packets sent.") - else: - verbose = True - - pkt_pad = auto_pad(pkt_raw) - ignore = [] - for _ in range(count): - txq.send(pkt_pad, verbose=verbose) - ignore.append(pkt_pad) - - # allow scapy to recognize IPFIX headers and templates - ipfix = IPFIXHandler() - data = None - # get IPFIX template and data - while True: - pkt = rxq.recv(10, ignore=ignore, verbose=verbose) - if pkt is None: - raise RuntimeError("RX timeout") - - if pkt.haslayer("ICMPv6ND_NS"): - # read another packet in the queue if the current one is ICMPv6ND_NS - continue - - if pkt.haslayer("IPFIXHeader"): - if pkt.haslayer("IPFIXTemplate"): - # create or update template for IPFIX data packets - ipfix.update_template(pkt) - elif pkt.haslayer("IPFIXData"): - data = pkt.getlayer(IPFIXData).fields - break - else: - raise RuntimeError("Unable to parse IPFIX set after header.") - else: - raise RuntimeError("Received non-IPFIX packet or IPFIX header " - "not recognized.") - - # verify packet count - if data["packetTotalCount"] != count: - raise RuntimeError("IPFIX reported wrong packet count. Count was {0}," - "but should be {1}".format(data["packetTotalCount"], - count)) - # verify IP addresses - keys = data.keys() - err = "{0} mismatch. Packets used {1}, but were classified as {2}." - if ip_version == IP: - if "IPv4_src" in keys: - if data["IPv4_src"] != src_ip: - raise RuntimeError( - err.format("Source IP", src_ip, data["IPv4_src"])) - if "IPv4_dst" in keys: - if data["IPv4_dst"] != dst_ip: - raise RuntimeError( - err.format("Destination IP", dst_ip, data["IPv4_dst"])) - else: - if "IPv6_src" in keys: - if data["IPv6_src"] != src_ip: - raise RuntimeError( - err.format("Source IP", src_ip, data["IPv6_src"])) - if "IPv6_dst" in keys: - if data["IPv6_dst"] != dst_ip: - raise RuntimeError( - err.format("Source IP", src_ip, data["IPv6_dst"])) - # verify port numbers - for item in ("src_port", "tcp_src_port", "udp_src_port"): - try: - if int(data[item]) != source_port: - raise RuntimeError( - err.format("Source port", source_port, data[item])) - except KeyError: - pass - for item in ("dst_port", "tcp_dst_port", "udp_dst_port"): - try: - if int(data[item]) != destination_port: - raise RuntimeError( - err.format("Source port", destination_port, data[item])) - except KeyError: - pass - # verify protocol ID - if "Protocol_ID" in keys: - if protocol == TCP and int(data["Protocol_ID"]) != 6: - raise RuntimeError("TCP Packets were classified as not TCP.") - if protocol == UDP and int(data["Protocol_ID"]) != 17: - raise RuntimeError("UDP Packets were classified as not UDP.") - sys.exit(0) - - -if __name__ == "__main__": - main() diff --git a/resources/traffic_scripts/ipfix_sessions.py b/resources/traffic_scripts/ipfix_sessions.py deleted file mode 100755 index 11e77fa08c..0000000000 --- a/resources/traffic_scripts/ipfix_sessions.py +++ /dev/null @@ -1,229 +0,0 @@ -#!/usr/bin/env python - -# Copyright (c) 2016 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. - -"""Traffic script - IPFIX listener.""" - -import sys -from ipaddress import IPv4Address, IPv6Address, AddressValueError - -from scapy.layers.inet import IP, TCP, UDP -from scapy.layers.inet6 import IPv6 -from scapy.layers.l2 import Ether - -from resources.libraries.python.telemetry.IPFIXUtil import IPFIXHandler, \ - IPFIXData -from resources.libraries.python.PacketVerifier import RxQueue, TxQueue, auto_pad -from resources.libraries.python.TrafficScriptArg import TrafficScriptArg - - -def valid_ipv4(ip): - """Check if IP address has the correct IPv4 address format. - - :param ip: IP address. - :type ip: str - :return: True in case of correct IPv4 address format, - otherwise return false. - :rtype: bool - """ - try: - IPv4Address(unicode(ip)) - return True - except (AttributeError, AddressValueError): - return False - - -def valid_ipv6(ip): - """Check if IP address has the correct IPv6 address format. - - :param ip: IP address. - :type ip: str - :return: True in case of correct IPv6 address format, - otherwise return false. - :rtype: bool - """ - try: - IPv6Address(unicode(ip)) - return True - except (AttributeError, AddressValueError): - return False - - -def verify_data(data, count, src_ip, dst_ip, protocol): - """Compare data in IPFIX flow report against parameters used to send test - packets. - - :param data: Dictionary of fields in IPFIX flow report. - :param count: Number of packets expected. - :param src_ip: Expected source IP address. - :param dst_ip: Expected destination IP address. - :param protocol: Expected protocol, TCP or UDP. - :type data: dict - :type count: int - :type src_ip: str - :type dst_ip: str - :type protocol: scapy.layers - """ - - # verify packet count - if data["packetTotalCount"] != count: - raise RuntimeError( - "IPFIX reported wrong packet count. Count was {0}," - " but should be {1}".format(data["packetTotalCount"], count)) - # verify IP addresses - keys = data.keys() - e = "{0} mismatch. Packets used {1}, but were classified as {2}." - if valid_ipv4(src_ip) and valid_ipv4(dst_ip): - if "IPv4_src" in keys: - if data["IPv4_src"] != src_ip: - raise RuntimeError( - e.format("Source IP", src_ip, data["IPv4_src"])) - if "IPv4_dst" in keys: - if data["IPv4_dst"] != dst_ip: - raise RuntimeError( - e.format("Destination IP", dst_ip, data["IPv4_dst"])) - else: - if "IPv6_src" in keys: - if data["IPv6_src"] != src_ip: - raise RuntimeError( - e.format("Source IP", src_ip, data["IPv6_src"])) - if "IPv6_dst" in keys: - if data["IPv6_dst"] != dst_ip: - raise RuntimeError( - e.format("Source IP", src_ip, data["IPv6_dst"])) - # verify protocol ID - if "Protocol_ID" in keys: - if protocol == TCP and int(data["Protocol_ID"]) != 6: - raise RuntimeError( - "TCP Packets were classified as not TCP.") - if protocol == UDP and int(data["Protocol_ID"]) != 17: - raise RuntimeError( - "UDP Packets were classified as not UDP.") - # return port number - for item in ("src_port", "tcp_src_port", "udp_src_port", - "dst_port", "tcp_dst_port", "udp_dst_port"): - if item in keys: - return int(data[item]) - else: - raise RuntimeError("Data contains no port information.") - - -def main(): - """Send packets to VPP, then listen for IPFIX flow report. Verify that - the correct packet count was reported.""" - args = TrafficScriptArg( - ['src_mac', 'dst_mac', 'src_ip', 'dst_ip', 'protocol', 'port', 'count', - 'sessions'] - ) - - dst_mac = args.get_arg('dst_mac') - src_mac = args.get_arg('src_mac') - src_ip = args.get_arg('src_ip') - dst_ip = args.get_arg('dst_ip') - tx_if = args.get_arg('tx_if') - - protocol = args.get_arg('protocol') - count = int(args.get_arg('count')) - sessions = int(args.get_arg('sessions')) - - txq = TxQueue(tx_if) - rxq = RxQueue(tx_if) - - # generate simple packet based on arguments - ip_version = None - if valid_ipv4(src_ip) and valid_ipv4(dst_ip): - ip_version = IP - elif valid_ipv6(src_ip) and valid_ipv6(dst_ip): - ip_version = IPv6 - else: - ValueError("Invalid IP version!") - - if protocol.upper() == 'TCP': - protocol = TCP - elif protocol.upper() == 'UDP': - protocol = UDP - else: - raise ValueError("Invalid type of protocol!") - - packets = [] - for x in range(sessions): - pkt = (Ether(src=src_mac, dst=dst_mac) / - ip_version(src=src_ip, dst=dst_ip) / - protocol(sport=x, dport=x)) - pkt = auto_pad(pkt) - packets.append(pkt) - - # do not print details for sent packets - verbose = False - print("Sending more than one packet. Details will be filtered for " - "all packets sent.") - - ignore = [] - for x in range(sessions): - for _ in range(count): - txq.send(packets[x], verbose=verbose) - ignore.append(packets[x]) - - # allow scapy to recognize IPFIX headers and templates - ipfix = IPFIXHandler() - - # clear receive buffer - while True: - pkt = rxq.recv(1, ignore=packets, verbose=verbose) - if pkt is None: - break - - data = None - ports = [x for x in range(sessions)] - - # get IPFIX template and data - while True: - pkt = rxq.recv(5) - if pkt is None: - raise RuntimeError("RX timeout") - - if pkt.haslayer("ICMPv6ND_NS"): - # read another packet in the queue if the current one is ICMPv6ND_NS - continue - - if pkt.haslayer("IPFIXHeader"): - if pkt.haslayer("IPFIXTemplate"): - # create or update template for IPFIX data packets - ipfix.update_template(pkt) - elif pkt.haslayer("IPFIXData"): - for x in range(sessions): - try: - data = pkt.getlayer(IPFIXData, x+1).fields - except AttributeError: - raise RuntimeError("Could not find data layer " - "#{0}".format(x+1)) - port = verify_data(data, count, src_ip, dst_ip, protocol) - if port in ports: - ports.remove(port) - else: - raise RuntimeError("Unexpected or duplicate port {0} " - "in flow report.".format(port)) - print("All {0} sessions verified " - "with packet count {1}.".format(sessions, count)) - sys.exit(0) - else: - raise RuntimeError("Unable to parse IPFIX template " - "or data set.") - else: - raise RuntimeError("Received non-IPFIX packet or IPFIX header was" - "not recognized.") - - -if __name__ == "__main__": - main() |