"""Configuration for ACLs."""
# Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
# Copyright (C) 2015 Research and Education Advanced Network New Zealand Ltd.
# Copyright (C) 2015--2018 The Contributors
#
# 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.
from faucet.valve_of import MATCH_FIELDS, OLD_MATCH_FIELDS
from faucet.conf import Conf, test_config_condition
[docs]class ACL(Conf):
"""Contains the state for an ACL, including the configuration.
ACL Config
ACLs are configured under the 'acls' configuration block. The acls block
contains a dictionary of individual acls each keyed by its name.
Each acl contains a list of rules, a packet will have the first matching rule
applied to it.
Each rule is a dictionary containing the single key 'rule' with the value the
matches and actions for the rule.
The matches are key/values based on the ryu RESTFul API.
The key 'actions' contains a dictionary with keys/values as follows:
* allow (int): if 1 allow the packet to continue through the Faucet \
pipeline, if 0 drop the packet.
* force_port_vlan (int): if 1, do not verify the VLAN/port association \
for this packet and override any VLAN ACL on the forced VLAN.
* meter (str): meter to apply to the packet
* output (dict): used to output a packet directly. details below.
* cookie (int): set flow cookie to this value on this flow
The output action contains a dictionary with the following elements:
* port (int or string): the port to output the packet to
* ports (list): a list of the ports (int or string) to output the packet to
* set_fields (list): a list of fields to set with values
* dl_dst (str): old style request to set eth_dst to a value (set_fields recommended)
* pop_vlans: (int): pop the packet vlan before outputting
* vlan_vid: (int): push the vlan vid on the packet when outputting
* vlan_vids: (list): push the list of vlans on the packet when outputting, with option eth_type
* swap_vid (int): rewrite the vlan vid of the packet when outputting
* failover (dict): Output with a failover port (experimental)
"""
rules = None
exact_match = None
defaults = {
'rules': None,
'exact_match': False,
}
defaults_types = {
'rules': list,
'exact_match': bool,
}
rule_types = {
'cookie': int,
'actions': dict,
'description': str,
}
actions_types = {
'meter': str,
'mirror': (str, int),
'output': dict,
'allow': int,
'force_port_vlan': int,
}
output_actions_types = {
'port': (str, int),
'ports': list,
'failover': dict,
'set_fields': list,
'dl_dst': str,
'pop_vlans': int,
'swap_vid': int,
'vlan_vid': int,
'vlan_vids': list,
}
def __init__(self, _id, dp_id, conf):
super(ACL, self).__init__(_id, dp_id, conf)
rules = conf
if isinstance(conf, dict):
if 'exact_match' in conf and conf['exact_match']:
self.exact_match = True
test_config_condition('rules' not in conf, 'no rules found for ACL %s' % _id)
rules = conf['rules']
self.rules = []
test_config_condition(not isinstance(rules, list), (
"ACL rules is %s not %s" % (type(rules), dict)))
for match_fields in (MATCH_FIELDS, OLD_MATCH_FIELDS):
for match in list(match_fields.keys()):
self.rule_types[match] = (str, int)
for rule in rules:
test_config_condition(not isinstance(rule, dict), (
"ACL rule is %s not %s" % (type(rule), dict)))
for rule_key, rule_content in list(rule.items()):
test_config_condition(rule_key != 'rule', "Incorrect ACL rule key")
test_config_condition(not isinstance(rule_content, dict), (
"ACL rule content is %s not %s") % (type(rule_content), dict))
self._check_conf_types(rule_content, self.rule_types)
for rule_field, rule_conf in list(rule_content.items()):
if rule_field == 'cookie':
test_config_condition(rule_conf < 0 or rule_conf > 2**16, (
'rule cookie value must be 0-2**16'))
elif rule_field == 'actions':
test_config_condition(not rule_conf, "Missing rule actions in ACL %s" % _id)
self._check_conf_types(rule_conf, self.actions_types)
for action_name, action_conf in list(rule_conf.items()):
if action_name == 'output':
self._check_conf_types(action_conf, self.output_actions_types)
self.rules.append(rule_content)
[docs] def to_conf(self):
return [{'rule': rule} for rule in self.rules]