X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2Fhoneycomb%2FHcAPIKwACL.py;h=a69ab460f628ad51c786f8bfe10b6ad33ab7f455;hp=c11e3251943e92faee77a589b53db043e1ac98cc;hb=811b8dc97ccf12952d5ec460bb0a421ce8933326;hpb=28e17b8002b50a04cdd6c9e74c15cdc4aa33a5e2 diff --git a/resources/libraries/python/honeycomb/HcAPIKwACL.py b/resources/libraries/python/honeycomb/HcAPIKwACL.py index c11e325194..a69ab460f6 100644 --- a/resources/libraries/python/honeycomb/HcAPIKwACL.py +++ b/resources/libraries/python/honeycomb/HcAPIKwACL.py @@ -14,6 +14,7 @@ """This module implements keywords to manipulate ACL data structures using Honeycomb REST API.""" +from resources.libraries.python.topology import Topology from resources.libraries.python.HTTPRequest import HTTPCodes from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError from resources.libraries.python.honeycomb.HoneycombUtil \ @@ -262,3 +263,177 @@ class ACLKeywords(object): return resp["classify-session"][0] except (KeyError, TypeError): return {} + + @staticmethod + def create_ietf_classify_chain(node, list_name, layer, data): + """Create classify chain using the ietf-acl node. + + :param node: Honeycomb node. + :param list_name: Name for the classify list. + :param layer: Network layer to classify on. + :param data: Dictionary of settings to send to Honeycomb. + :type node: dict + :type list_name: str + :type layer: string + :type data: dict + + :return: Content of response. + :rtype: bytearray + :raises HoneycombError: If the operation fails. + """ + layer = layer.lower() + suffix_dict = {"l2": "eth", + "l3_ip4": "ipv4", + "l3_ip6": "ipv6", + "mixed": "mixed" + } + if layer == "l4": + raise NotImplementedError + try: + suffix = suffix_dict[layer] + except KeyError: + raise ValueError("Unexpected value of layer argument {0}." + "Valid options are: {1}" + .format(layer, suffix_dict.keys())) + + if layer == "mixed": + path = "/acl/vpp-acl:{0}-acl/{1}" + else: + path = "/acl/ietf-access-control-list:{0}-acl/{1}" + + path = path.format(suffix, list_name) + + status_code, resp = HcUtil.put_honeycomb_data( + node, "config_ietf_classify_chain", data, path) + + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Could not create classify chain." + "Status code: {0}.".format(status_code)) + + return resp + + @staticmethod + def set_ietf_interface_acl(node, interface, layer, direction, list_name, + default_action, mode=None): + """Assign an interface to an ietf-acl classify chain. + + :param node: Honeycomb node. + :param interface: Name of an interface on the node. + :param layer: Network layer to classify packets on. + Valid options are: L2, L3, L4. Mixed ACL not supported yet. + :param direction: Classify incoming or outgiong packets. + Valid options are: ingress, egress + :param list_name: Name of an ietf-acl classify chain. + :param default_action: Default classifier action: permit or deny. + :param mode: When using mixed layers, this specifies operational mode + of the interface - L2 or L3. If layer is not "mixed", this argument + will be ignored. + :type node: dict + :type interface: str or int + :type layer: str + :type direction: str + :type list_name: str + :type default_action: str + :type mode: str + + :return: Content of response. + :rtype: bytearray + :raises HoneycombError: If the operation fails. + """ + + layer = layer.lower() + if mode is not None: + mode = mode.lower() + interface = Topology.convert_interface_reference( + node, interface, "name") + + interface = interface.replace("/", "%2F") + + if direction not in ("ingress", "egress"): + raise ValueError("Unknown traffic direction {0}. " + "Valid options are: ingress, egress." + .format(direction)) + + path = "/interface/{0}/ietf-acl/{1}/access-lists".format( + interface, direction) + + types = { + "ietf": "ietf-access-control-list:{0}-acl", + "vpp": "vpp-acl:{0}-acl"} + layers = { + "l2": {"mode": "l2", "acl_type": types['ietf'].format("eth")}, + "l3_ip4": {"mode": "l3", "acl_type": types['ietf'].format("ipv4")}, + "l3_ip6": {"mode": "l3", "acl_type": types['ietf'].format("ipv6")}, + "mixed": {"mode": mode, "acl_type": types['vpp'].format("mixed")} + } + + if layer == "L4": + raise NotImplementedError + else: + try: + data = { + "access-lists": { + "acl": [ + { + "type": layers[layer]['acl_type'], + "name": list_name + } + ], + "default-action": default_action, + "mode": layers[layer]['mode'] + } + } + except KeyError: + raise ValueError("Unknown network layer {0}. " + "Valid options are: {1}".format( + layer, layers.keys())) + + status_code, resp = HcUtil.put_honeycomb_data( + node, "config_vpp_interfaces", data, path) + + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Could not configure ACL on interface. " + "Status code: {0}.".format(status_code)) + + return resp + + @staticmethod + def delete_ietf_interface_acls(node, interface): + """Remove all ietf-acl assignments from an interface. + + :param node: Honeycomb node. + :param interface: Name of an interface on the node. + :type node: dict + :type interface: str or int""" + + interface = Topology.convert_interface_reference( + node, interface, "name") + + interface = interface.replace("/", "%2F") + + path = "/interface/{0}/ietf-acl/".format(interface) + status_code, _ = HcUtil.delete_honeycomb_data( + node, "config_vpp_interfaces", path) + + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Could not remove ACL assignment from interface. " + "Status code: {0}.".format(status_code)) + + @staticmethod + def delete_ietf_classify_chains(node): + """Remove all classify chains from the ietf-acl node. + + :param node: Honeycomb node. + :type node: dict + """ + + status_code, _ = HcUtil.delete_honeycomb_data( + node, "config_ietf_classify_chain") + + if status_code != HTTPCodes.OK: + raise HoneycombError( + "Could not remove ietf-acl chain. " + "Status code: {0}.".format(status_code))