ACL YANG modelJuniper Networksdeanb@juniper.netBrocade Communications Systemkkoushik@brocade.comCisco Systemsdblair@cisco.com
Operations and Management Area
NETMOD WGThis document describes information and data model of Access Control List (ACL) basic building blocks.
Access Control List (ACL) are one of the basic elements to configure
device forwarding behavior. It is used in many networking concepts
such as Policy Based Routing, Firewalls etc.An ACL is an ordered set of rules that is used to filter traffic on a
networking device. Each rule is represented by an Access Control
Entry (ACE).Each ACE has a group of match criteria and a group of action criteria.The match criteria consist of tuple of match criteria and metadata matching.Packet header matches apply to fields visible in the packet such as
address or class of service or port numbers.Metadata matching applies to fields associated with the packet but
not in the packet header such as input interface or overall packet lengthThe actions specify what to do with the packet when the matching criteria is
met. These can be any sort of thing from counting to policing or simply
forwarding.The list of potential actions is endless depending on the
innovations of the networked devices.ACE: Access Control EntryACL: Access Control ListAFI: Address Field IdentifierARP: Address Resolution ProtocolCoS: Class of ServiceDSCP: Differentiated Services Code PointICMP: Internet Control Message ProtocolIGMP: Internet Group Management ProtocolIP: Internet ProtocolIPv4: Internet Protocol version 4IPv6: Internet Protocol version 6MAC: Media Access ControlQoS: Quality of ServiceTCP: Transmission Control ProtocolToS: Type of ServiceTTL: Time To LiveUDP: User Datagram ProtocolVLAN: Virtual Local Area NetworkVRF: Virtual Routing and ForwardingThis document defines a YANG data model for the configuration of ACLs. It is very important that model can be easily reused between vendors and between applications.ACL implementations in every device may vary greatly in terms of the filter constructs and Actions that they support. Therefore this draft proposes a simple model that augmented by vendor proprietary models. Although different vendors have different ACL data models, there is a common understanding of what an access list is. An access list contains an ordered list of rules called access list entries – ACEs. Actions on the first matching ACE are applied with no processing of subsequent ACEs. Each ACE has a group of match criteria and a group of action criteria. The match criteria consist of packet header matching and metadata matching. Packet header matches apply to fields visible in the packet such as address or class of service or port numbers. Metadata matching applies to fields associated with the packet, but not in the packet header such as input interface, packet length, or source or destination prefix length. The actions can be any sort of thing from logging to rate limiting or dropping to simply forwarding. There is a default ACE which applies if a packet does not match any of the other ACEs. As some devices fail closed (reject), some fail open (accept) with no explicit configuration, this model defines daufault action, ACE which applies if a packet does not match any of the other ACEs. This will help with cross platform conformitiy and for that reason this draft specifies deny as default action. There is overall operational state for the ACL and operational state for each ACE, and depending on the action, operational state for each action. Access-lists can also have notifications such as logging, configuration changing, activation state changes. The ACL can be applied to targets within the device which may be interfaces of a networked device, applications or features running in the device, or other objects. When applied to interfaces of the networked device, the ACL is applied in a direction which indicates if it should be applied to packet entering (input) or leaving the device (output).This draft tries to address the commonalities between all vendors and create a common model, which can be augmented with proprietary models. The base model is very simple and with this design we hope to achieve needed flexibility for each vendor to extend the base model.There are three YANG modules in the model. The first module, "ietf-acl", defines generic ACL aspects which are common to all ACLs regardless of their type or vendor. In effect, the module can be viewed as providing a generic ACL "superclass". It imports module "packet-headers" into the match container. The packet headers can be extended with different types and fragments.The packet headers modules can easily be extended to reuse definitions from other modules such as IPFIX or migrate proprietary augmented module definitions into the standard module.Two other module "newco-acl" is example of company proprietary model, that augments the ietf-acl module with definitions that are specific to match criteria and company proprietary extensions to match and action criteria. The model below is shown just an example and it is expected from vendors to create their own propietary models, based on the example below.
"ietf-acl" is the standard top level module for Access lists. It has
a container for "access-list" to store access list information.
This container has information identifying the access list by a
name("acl-name") and a list("access-list-entries") of rules associated
with the "acl-name".
Each of the entries in the list("access-list-entries") indexed by the
string "rule-name" have containers defining "matches" and "actions".
The "matches" define criteria used to identify patterns in
"packet-fields".
The "actions" define behavior to undertake once a "match" has been
identified.The packet fields module defines the necessary groups for matching on fields in the packet including ethernet, ipv4, ipv6, transport layer fields and metadata. These groupings can be augmented to include other proprietary matching criteria. Since the number of match criteria is very large, the base draft does not include these directly but references them by "uses" to keep the base module simple.In the figure below is an example how proprietary models can be created on top of base ACL module. It is a simple example of how to use 'augment' with an XPath expression which extends instances of a particular type. In this example, all /ietf-acl:access-list/ietf-acl:access-list-entries/ietf-acl:matches are augmented with a new choice, protocol-payload-choice. The protocol-payload-choice uses a grouping with an enumeration of all supported protocol values. In other example, /ietf-acl:access-list/ietf-acl:access-list-entries/ietf-acl:actions are augmented with new choice of actions. Here is an inclusive list of cases listed within a choice statement.Dratf authors expect that different vendors will provide their own yang models as in the example above, which is the extension of the base modelRequirement: Deny All traffic from 1.1.1.1 bound for host 2.2.2.2 from leaving.In order to achieve the requirement, an name access control list is needed. The acl and aces can be described in CLI as the following:Here is the example acl configuration xml:As Linux platform is becoming more popular as networking platform, the Linux data model is changing. Previously ACLs in Linux were highly protocol specific and different utilities were used for it (iptables, ip6tables, arptables, ebtables). Recently, this has changed and a single utility, nftables, has been provided. This utility follows very similarly the same base model as proposed in this draft. The nftables support input and output ACEs and each ACE can be defined with match and action.The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [RFC6241] . The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is SSH [RFC6242] . The NETCONF access control model [RFC6536] provides the means to restrict access for particular NETCONF users to a pre-configured subset of all available NETCONF protocol operations and content.There are a number of data nodes defined in the YANG module which are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., <edit-config>) to these data nodes without proper protection can have a negative effect on network operations.TBD: List specific Subtrees and data nodes and their
sensitivity/vulnerability.
This document registers a URI in the IETF XML registry [RFC3688] .
Following the format in RFC 3688, the following registration is
requested to be made: URI: urn:ietf:params:xml:ns:yang:ietf-acl Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace.This document registers a YANG module in the YANG Module Names
registry [RFC6020].name: ietf-acl
namespace: urn:ietf:params:xml:ns:yang:ietf-acl
prefix: ietf-acl
reference: RFC XXXX