| Internet-Draft | Enhanced ACLs | December 2024 |
| Dios, et al. | Expires 22 June 2025 | [Page] |
RFC 8519 defines a YANG data model for Access Control Lists (ACLs). This document discusses a set of extensions that fix many of the limitations of the ACL model as initially defined in RFC 8519.¶
The document also defines IANA-maintained modules for ICMP types and IPv6 extension headers.¶
This note is to be removed before publishing as an RFC.¶
Discussion of this document takes place on the Network Modeling Working Group mailing list (netmod@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/netmod/.¶
Source for this draft and an issue tracker can be found at https://github.com/boucadair/enhanced-acl-netmod.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 22 June 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
[RFC8519] defines Access Control Lists (ACLs) as a user-ordered set of filtering rules. The model targets the configuration of the filtering behavior of a device. However, the model structure, as defined in [RFC8519], suffers from a set of limitations. This document describes these limitations and specifies an enhanced ACL structure (Section 4). The motivation of such enhanced ACL structure is discussed in detail in Appendix D.¶
When managing ACLs, it is common for network operators to group match elements in pre-defined sets. The consolidation into group matches allows for reducing the number of rules, especially in large scale networks. If, for example, it is needed to find a match against 100 IP addresses (or prefixes), a single rule will suffice rather than creating individual Access Control Entries (ACEs) for each IP address (or prefix). In doing so, implementations would optimize the performance of matching lists vs multiple rules matching.¶
The enhanced ACL structure ("ietf-acl-enh", Section 4) is also meant to facilitate the management of network operators. Instead of entering the IP address or port number literals, using user-named lists decouples the creation of the rule from the management of the sets. Hence, it is possible to remove/add entries to the list without redefining the (parent) ACL rule.¶
In addition, the notion of ACL and defined sets is generalized so that it is not device-specific as per [RFC8519]. ACLs and defined sets may be defined at network/administrative domain level and associated to devices. This approach facilitates the reusability across multiple network elements. For example, managing the IP prefix sets from a network level makes it easier to maintain by the security groups.¶
Network operators maintain sets of IP prefixes that are related to each other, e.g., deny-lists or accept-lists that are associated with those provided by a VPN customer. These lists are maintained and manipulated by security expert teams.¶
Note that ACLs are used locally in devices but are triggered by other tools such as DDoS mitigation [RFC9132] or BGP Flow Spec [RFC8955] [RFC8956]. Therefore, supporting means to easily map to the filtering rules conveyed in messages triggered by these tools is valuable from a network operation standpoint.¶
The enhanced ACL module (Section 4) conforms to the Network Management Datastore Architecture (NMDA) defined in [RFC8342].¶
A set of examples to illustrate the use of the enhanced ACL module are provided in Appendix E.¶
The document also defines IANA-maintained modules for ICMP types and IPv6 extension headers. The design of the modules adheres to the recommendations in Section 4.30.2 of [I-D.ietf-netmod-rfc8407bis]. The templates to generate the modules are available in Appendix A.1, Appendix B.1, and Appendix C.1. The templates use an XSLT stylesheet from the 'iana-yang' project [YANG-XSLT]. Readers should refer to the IANA websites [IANA_ICMPv4_YANG_URL], [IANA_ICMPv6_YANG_URL], and [IANA_IPV6_YANG_URL] to retrieve the latest version of these IANA-maintained modules.¶
Note to the RFC Editor: This section is to be removed prior to publication.¶
This document contains placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed.¶
(1) Please apply the following replacements:¶
XXXX --> the assigned RFC number for this I-D¶
2024-05-16 --> the actual date of the publication of this document¶
(2) The modules are provided in Appendix A.2, Appendix B.2, and Appendix C.2 for the users convenience before publication as RFC. Please remove these appendices from the final RFC.¶
(3) Please update the following references:¶
IANA_ICMPv4_YANG_URL --> The URL to retrieve the latest version of the IANA-maintained ICMPv4 module.¶
IANA_ICMPv6_YANG_URL --> The URL to retrieve the latest version of the IANA-maintained ICMPv6 module.¶
IANA_IPV6_YANG_URL --> The URL to retrieve the latest version of the IPv6 Extension Header Types IANA module.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The terminology for describing YANG modules is defined in [RFC7950]. The meaning of the symbols in the tree diagrams is defined in [RFC8340].¶
In addition to the terms defined in [RFC8519], this document makes use of the following term:¶
Refers to reusable description of one or multiple information elements (e.g., IP address, IP prefix, port number, or ICMP type).¶
Figure 1 shows the full tree of the enhanced ACL module (Section 4):¶
module: ietf-acl-enh
augment /acl:acls:
+--rw defined-sets
+---u defined-sets
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches:
+--rw (payload)?
| +--:(pattern)
| +--rw pattern {match-on-payload}?
| +---u payload-match
+--rw (alias)?
| +--:(alias-name)
| +--rw alias-name* alias-ref
+--rw (mpls)?
+--:(mpls-values)
+--rw mpls-values {match-on-mpls}?
+---u mpls-match-parameters-config
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l2:
+--rw vlan-filter {match-on-vlan-filter}?
| +--rw frame-type? string
| +--rw (vlan-type)?
| +--:(range)
| | +--rw lower-vlan uint16
| | +--rw upper-vlan uint16
| +--:(operator)
| +--rw operator? packet-fields:operator
| +--rw vlan* uint16
+--rw isid-filter {match-on-isid-filter}?
+--rw (isid-type)?
+--:(range)
| +--rw lower-isid uint16
| +--rw upper-isid uint16
+--:(operator)
+--rw operator? packet-fields:operator
+--rw isid* uint16
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l3
/acl:ipv4/acl:ipv4:
+--rw ipv4-fragment
| +---u fragment-fields
+--rw source-ipv4-prefix-list? ipv4-prefix-set-ref
+--rw destination-ipv4-prefix-list? ipv4-prefix-set-ref
+--rw next-header-set? protocol-set-ref
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l3
/acl:ipv6/acl:ipv6:
+--rw ipv6-fragment
| +---u fragment-fields
+--rw source-ipv6-prefix-list? ipv6-prefix-set-ref
+--rw destination-ipv6-prefix-list? ipv6-prefix-set-ref
+--rw protocol-set? protocol-set-ref
+--rw extension-header?
iana-ipv6-ext-types:ipv6-extension-header-type
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l4
/acl:tcp/acl:tcp:
+--rw flags-bitmask
| +---u tcp-flags
+--rw source-tcp-port-set? port-set-ref
+--rw destination-tcp-port-set? port-set-ref
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l4
/acl:udp/acl:udp:
+--rw source-udp-port-set? port-set-ref
+--rw destination-udp-port-set? port-set-ref
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:matches/acl:l4
/acl:icmp/acl:icmp:
+--rw icmpv4-set? icmpv4-type-set-ref
+--rw icmpv6-set? icmpv6-type-set-ref
augment /acl:acls/acl:acl/acl:aces/acl:ace/acl:actions:
+---u acl-complementary-actions
+--rw rate-limit? decimal64
Figure 2 shows the reusable groupings that are defined in the enhanced ACL module:¶
grouping tcp-flags:
+--rw operator? operator
+-- (mode)?
+--:(explicit)
| +-- explicit-tcp-flag* identityref
+--:(builtin)
+-- bitmask? uint16
grouping fragment-fields:
+-- operator? operator
+-- type? fragment-type
grouping mpls-match-parameters-config:
+-- traffic-class? uint8
+-- label-position? identityref
+-- upper-label-range? rt-types:mpls-label
+-- lower-label-range? rt-types:mpls-label
+-- label-block-name? string
+-- ttl-value? uint8
grouping payload-match:
+-- offset? identityref
+-- length? uint64
+-- operator? operator
+-- pattern? binary
grouping alias:
+-- vlan* uint16
+-- prefix* inet:ip-prefix
+-- port-range* [lower-port]
| +-- lower-port inet:port-number
| +-- upper-port? inet:port-number
+-- protocol* uint8
+-- fqdn* inet:domain-name
+-- uri* inet:uri
grouping icmpv4-header-fields:
+-- type? iana-icmpv4-types:icmpv4-type
+-- code? uint8
+-- rest-of-header? binary
grouping icmpv6-header-fields:
+-- type? iana-icmpv6-types:icmpv6-type
+-- code? uint8
+-- rest-of-header? binary
grouping acl-complementary-actions:
+-- log-action
| +-- log-type? identityref
| +-- log-id? string
+-- counter-action
+-- counter-type? identityref
+-- counter-name* string
grouping ipv4-prefix-sets:
+-- prefix-set* [name]
+-- name string
+-- description? string
+-- prefix* inet:ipv4-prefix
grouping ipv6-prefix-sets:
+-- prefix-set* [name]
+-- name string
+-- description? string
+-- prefix* inet:ipv6-prefix
grouping port-sets:
+-- port-set* [name]
+-- name string
+-- port* [id]
+-- id string
+-- (port)?
+--:(port-range-or-operator)
+-- port-range-or-operator
+---u packet-fields:port-range-or-operator
grouping protocol-sets:
+-- protocol-set* [name]
+-- name string
+-- protocol* union
grouping icmpv4-type-sets:
+-- set* [name]
+-- name string
+-- icmpv4-type* [type]
+---u icmpv4-header-fields
grouping icmpv6-type-sets:
+-- set* [name]
+-- name string
+-- icmpv6-type* [type]
+---u icmpv6-header-fields
grouping aliases:
+-- alias* [name]
+-- name string
+---u alias
grouping defined-sets:
+-- ipv4-prefix-sets
| +---u ipv4-prefix-sets
+-- ipv6-prefix-sets
| +---u ipv6-prefix-sets
+-- port-sets
| +---u port-sets
+-- protocol-sets
| +---u protocol-sets
+-- icmpv4-type-sets
| +---u icmpv4-type-sets
+-- icmpv6-type-sets
| +---u icmpv6-type-sets
+-- aliases
+---u aliases
The augmented ACL structure includes several containers to manage reusable sets of elements that can be matched in an ACL entry. Each set is uniquely identified by a name and can be called from the relevant entry. The following sets are defined (Figure 1):¶
An IPv4 prefix set contains a list of IPv4 prefixes. A match will be considered if the IP address (source or destination, depending on the ACL entry) is contained in any of the prefixes in the set.¶
An IPv6 prefix contains a list of IPv6 prefixes. A match will be considered if the IP address (source or destination, depending on the ACL entry) is contained in any of the prefixes in the set.¶
A port set contains a list of port numbers to be used in transpot protocol entries (e.g., TCP and UDP).¶
The port numbers can be individual port numbers, a range of port numbers, and an operation.¶
A protocol set contains a list of protocol values. Each protocol can be identified either by a number (e.g., 17) or a name (e.g., UDP).¶
An ICMP set contains a list of ICMPv4 [RFC0792] or ICMPv6 [RFC4443] types, each of them identified by a type value, optionally the code and the rest of the header.¶
New IANA-maintained modules for ICMP types are defined in this document.¶
An alias is defined by a combination of various parameters (e.g., IP prefix, protocol, port number, or VLAN [IEEE802.1Qcp]). Sets of aliases can be defined and referred to in ACL match criteria.¶
The module can be used to manage ACLs that require matching against IPv6 extension headers [RFC8200]. To that aim, a new IANA-maintained module for IPv6 extension header types "iana-ipv6-ext-types" is defined in this document.¶
The augmented ACL structure (Figure 1) includes a new container 'flags-bitmask' to better handle TCP flags (Section 3.1 of [RFC9293]). Assigned TCP flags are maintained in the "TCP Header Flags" registry under the "Transmission Control Protocol (TCP) Parameters" registry group [IANA-TCP-FLAGS].¶
Clients that support both 'flags-bitmask' and 'flags' [RFC8519] matching fields MUST NOT set these fields in the same request.¶
The augmented ACL structure (Figure 1) includes new leafs 'ipv4-fragment' and 'ipv6-fragment' to better handle fragments.¶
Clients that support both 'ipv4-fragment' and 'flags' [RFC8519] matching fields MUST NOT set these fields in the same request.¶
Some transport protocols use existing protocols (e.g., TCP or UDP) as substrate. The match criteria for such protocols may rely upon the 'protocol' under 'l3', TCP/UDP match criteria, part of the TCP/UDP payload, or a combination thereof.¶
A new feature, called 'match-on-payload', is defined in the document. This can be used, for example, for QUIC [RFC9000] or for tunneling protocols. This feature requires configuring a data offset, a length, and a binary pattern to macth data against using a specified operator.¶
The enhanced ACL module (Section 4) can be used to create rules to match against MPLS fields of a packet. The MPLS header defined in [RFC3032] and [RFC5462] contains the following fields:¶
Traffic Class: The 3-bit "Exp" field [RFC3032] which is renamed to "Traffic Class field" ("TC field") [RFC5462].¶
Label Value: A 20-bit field that carries the actual value of the MPLS label.¶
TTL: A 8-bit field used to encode Time to Live (TTL) value.¶
The augmented ACL structure (Figure 1) allows an operator to configure ACLs that match based upon the following data nodes:¶
Being able to filter all packets that are bridged within a VLAN or that are routed into or out of a bridge domain is part of the VPN control requirements for Ethernet VPN (EVPN) [RFC7209].¶
All packets that are bridged within a VLAN or that are routed into or out of a VLAN can be captured, forwarded, translated, or discarded based on the network policy.¶
Provider backbone bridging (PBB) was originally defined as Virtual Bridged Local Area Networks [IEEE-802-1ah] standard. However, instead of multiplexing VLANs, PBB duplicates the MAC layer of the customer frame and separates it from the provider domain, by encapsulating it in a 24-bit instance service identifier (I-SID). This provides more transparency between the customer network and the provider network.¶
The I-component forms the customer or access facing interface or routing instance. The I-component is responsible for mapping customer Ethernet traffic to the appropriate I-SID. It is mandatory to configure the default service identifier in the network.¶
Being able to filter by I-component Service identifier is a feature of the EVNP-PBB configuration.¶
In order to support rate-limiting (see Appendix D.6), a new action called 'rate-limit' is defined in this document.¶
Also, the "ietf-acl-enh" module supports new actions to complement existing ones: Log ('log-action') and write a counter ('counter-action'). The version of the module defined in this document supports only local actions.¶
This model imports types from [RFC6991], [RFC8519], and [RFC8294].¶
<CODE BEGINS> file "ietf-acl-enh@2024-05-16.yang"
module ietf-acl-enh {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-acl-enh";
prefix acl-enh;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-access-control-list {
prefix acl;
reference
"RFC 8519: YANG Data Model for Network Access
Control Lists (ACLs), Section 4.1";
}
import ietf-packet-fields {
prefix packet-fields;
reference
"RFC 8519: YANG Data Model for Network Access
Control Lists (ACLs), Section 4.2";
}
import ietf-routing-types {
prefix rt-types;
reference
"RFC 8294: Common YANG Data Types for the Routing Area";
}
import iana-icmpv4-types {
prefix iana-icmpv4-types;
reference
"RFC XXXX: Extensions to the Access Control Lists (ACLs)
YANG Model";
}
import iana-icmpv6-types {
prefix iana-icmpv6-types;
reference
"RFC XXXX: Extensions to the Access Control Lists (ACLs)
YANG Model";
}
import iana-ipv6-ext-types {
prefix iana-ipv6-ext-types;
reference
"RFC XXXX: Extensions to the Access Control Lists (ACLs)
YANG Model";
}
organization
"IETF NETMOD Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netmod/
WG List: mailto:netmod@ietf.org
Author: Mohamed Boucadair
mailto:mohamed.boucadair@orange.com
Author: Samier Barguil
mailto:samier.barguil_giraldo@nokia.com
Author: Oscar Gonzalez de Dios
mailto:oscar.gonzalezdedios@telefonica.com";
description
"This module contains YANG definitions for enhanced ACLs.
Copyright (c) 2024 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Revised BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision 2024-05-16 {
description
"Initial revision.";
reference
"RFC XXXX: Extensions to the Access Control Lists (ACLs)
YANG Model";
}
feature match-on-payload {
description
"Match based on a pattern is supported.";
}
feature match-on-vlan-filter {
description
"Match based on a VLAN range of vlan list is supported.";
}
feature match-on-isid-filter {
description
"Match based on an I-SID range of VLAN list is supported.";
}
feature match-on-alias {
description
"Match based on aliases.";
}
feature match-on-mpls {
description
"Match based on MPLS headers.";
}
identity offset-type {
description
"Base identity for payload offset type.";
}
identity layer2 {
base offset-type;
description
"The offset starts at the beginning of the Data Link layer
header.";
}
identity layer3 {
base offset-type;
description
"The offset starts at the beginning of the IP header.";
}
identity layer4 {
base offset-type;
description
"The offset start right after the IP header. This can be
typically the beginning of transport header (e.g., TCP
or UDP).";
}
identity payload {
base offset-type;
description
"The offset start right after the end of the transport
payload. For example, this represents the beginning of the
TCP data right after any TCP options or the beginning of
the UDP payload right after the UDP header.";
}
identity tcp-flag {
description
"Base Identity for the TCP Flags.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity ack {
base tcp-flag;
description
"Acknowledgment TCP flag bit.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity syn {
base tcp-flag;
description
"Synchronize sequence numbers.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity fin {
base tcp-flag;
description
"No more data from the sender.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity urg {
base tcp-flag;
description
"Urgent pointer TCP flag bit.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity psh {
base tcp-flag;
description
"The Push function flag is similar to the URG flag and tells
the receiver to process these packets as they are received
instead of buffering them.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity rst {
base tcp-flag;
description
"Reset TCP flag bit.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity ece {
base tcp-flag;
description
"ECN-Echo TCP flag bit.";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity cwr {
base tcp-flag;
description
"Congestion Window Reduced flag bit";
reference
"RFC 9293: Transmission Control Protocol (TCP), Section 3.1";
}
identity mpls-acl-type {
base acl:acl-base;
description
"An ACL that matches on fields from the MPLS header.";
}
identity label-position {
description
"Base identity for deriving MPLS label position.";
}
identity top {
base label-position;
description
"Top of the label stack.";
}
identity bottom {
base label-position;
description
"Bottom of the label stack.";
}
identity log-types {
description
"Base identity for deriving the Log actions.";
}
identity local-log {
base log-types;
description
"A local log is used to record the ACL results.";
}
identity counter-type {
description
"Base identity for deriving the counter actions.";
}
identity counter-name {
base counter-type;
description
"Identity for counter name to be updated based on
the ACL match actions.";
}
typedef operator {
type bits {
bit not {
position 0;
description
"If set, logical negation of operation.";
}
bit match {
position 1;
description
"Match bit. This is a bitwise match operation defined as
'(data & value) == value'.";
}
bit any {
position 2;
description
"Any bit. This is a match on any of the bits in bitmask.
It evaluates to 'true' if any of the bits in the
value mask are set in the data, i.e.,
'(data & value) != 0'.";
}
}
description
"Specifies how to apply the defined bitmask.
'any' and 'match' bits must not be set simultaneously.";
}
typedef fragment-type {
type bits {
bit df {
position 0;
description
"Don't fragment bit for IPv4.
Must be set to 0 when it appears in an IPv6 filter.";
}
bit isf {
position 1;
description
"Is a fragment.";
}
bit ff {
position 2;
description
"First fragment.";
}
bit lf {
position 3;
description
"Last fragment.";
}
}
description
"Different fragment types to match against.";
}
typedef ipv4-prefix-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:ipv4-prefix-sets"
+ "/acl-enh:prefix-set/acl-enh:name";
}
description
"Defines a reference to an IPv4 prefix set.";
}
typedef ipv6-prefix-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:ipv6-prefix-sets"
+ "/acl-enh:prefix-set/acl-enh:name";
}
description
"Defines a reference to an IPv6 prefix set.";
}
typedef port-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:port-sets"
+ "/acl-enh:port-set/acl-enh:name";
}
description
"Defines a reference to a port set.";
}
typedef protocol-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:protocol-sets"
+ "/acl-enh:protocol-set/acl-enh:name";
}
description
"Defines a reference to a protocol set.";
}
typedef icmpv4-type-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:icmpv4-type-sets"
+ "/acl-enh:set/acl-enh:name";
}
description
"Defines a reference to an ICMPv4 type set.";
}
typedef icmpv6-type-set-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:icmpv6-type-sets"
+ "/acl-enh:set/acl-enh:name";
}
description
"Defines a reference to an ICMPv6 type set.";
}
typedef alias-ref {
type leafref {
path "/acl:acls/acl-enh:defined-sets/acl-enh:aliases"
+ "/acl-enh:alias/acl-enh:name";
}
description
"Defines a reference to an alias.";
}
grouping tcp-flags {
description
"Operations on TCP flags.";
leaf operator {
type operator;
description
"How to interpret the TCP flags.";
}
choice mode {
description
"Choice of how flags are indicated.";
case explicit {
leaf-list explicit-tcp-flag {
type identityref {
base acl-enh:tcp-flag;
}
description
"An explicit list of the TCP flags that are to be
matched.";
}
}
case builtin {
leaf bitmask {
type uint16;
description
"The bitmask matches the last 4 bits of byte 13
and byte 14 of the TCP header.
For clarity, the 4 bits of byte 12
corresponding to the TCP data offset field are not
included in any matching.
Assigned TCP flags and their position are maintained
in the IANA'Transmission Control Protocol (TCP)
Parameters' registry group.";
reference
"RFC 9293: Transmission Control Protocol (TCP),
Section 3.1
https://www.iana.org/assignments/tcp-parameters";
}
}
}
}
grouping fragment-fields {
description
"Operations on fragment types.";
leaf operator {
type operator;
default "match";
description
"How to interpret the fragment type.";
}
leaf type {
type fragment-type;
description
"What fragment type to look for.";
}
}
grouping mpls-match-parameters-config {
description
"Parameters for the configuration of MPLS match rules.";
leaf traffic-class {
type uint8 {
range "0..7";
}
description
"The value of the MPLS traffic class (TC) bits,
formerly known as the EXP bits.";
}
leaf label-position {
type identityref {
base acl-enh:label-position;
}
description
"Position of the label.";
}
leaf upper-label-range {
type rt-types:mpls-label;
description
"Match MPLS label value on the MPLS header.
The usage of this field indicated the upper
range value in the top of the stack.
This label value does not include the
encodings of Traffic Class and TTL.";
reference
"RFC 3032: MPLS Label Stack Encoding";
}
leaf lower-label-range {
type rt-types:mpls-label;
description
"Match MPLS label value on the MPLS header.
The usage of this field indicated the lower
range value in the top of the stack.
This label value does not include the
encodings of Traffic Class and TTL.";
reference
"RFC 3032: MPLS Label Stack Encoding";
}
leaf label-block-name {
type string;
description
"Reference to a label block predefiend in the
implementation.";
}
leaf ttl-value {
type uint8;
description
"Time-to-live MPLS packet value match.";
reference
"RFC 3032: MPLS Label Stack Encoding";
}
}
grouping payload-match {
description
"Operations on payload match.";
leaf offset {
type identityref {
base acl-enh:offset-type;
}
description
"Indicates the payload offset. This will indicate
the position of the data in packet to use for
the match.";
}
leaf length {
type uint64;
units "bytes";
description
"Indicates the number of bytes, starting from the offset to
cover when performing the prefix match.";
}
leaf operator {
type operator;
default "match";
description
"How to interpret the prefix match.";
}
leaf pattern {
type binary;
description
"The binary pattern to match against.";
}
}
grouping alias {
description
"Specifies an alias.";
leaf-list vlan {
type uint16;
description
"VLAN of the alias.";
reference
"IEEE Std 802.1Q: Bridges and Bridged Networks";
}
leaf-list prefix {
type inet:ip-prefix;
description
"IPv4 or IPv6 prefix of the alias.";
}
list port-range {
key "lower-port";
description
"Port range. When only lower-port is
present, it represents a single port number.";
leaf lower-port {
type inet:port-number;
mandatory true;
description
"Lower port number of the port range.";
}
leaf upper-port {
type inet:port-number;
must '. >= ../lower-port' {
error-message
"The upper-port number must be greater than
or equal to the lower-port number.";
}
description
"Upper port number of the port range.";
}
}
leaf-list protocol {
type uint8;
description
"Identifies the target protocol number.
For example, 6 for TCP or 17 for UDP.";
}
leaf-list fqdn {
type inet:domain-name;
description
"FQDN identifying the target.";
}
leaf-list uri {
type inet:uri;
description
"URI identifying the target.";
}
}
grouping icmpv4-header-fields {
description
"Collection of ICMPv4 header fields that can be
used to set up a match filter.";
leaf type {
type iana-icmpv4-types:icmpv4-type;
description
"Also known as control messages.";
reference
"RFC 792: Internet Control Message Protocol.";
}
leaf code {
type uint8;
description
"ICMP subtype.";
reference
"RFC 792: Internet Control Message Protocol.";
}
leaf rest-of-header {
type binary;
description
"Unbounded in length, the contents vary based on the
ICMP type and code.";
reference
"RFC 792: Internet Control Message Protocol";
}
}
grouping icmpv6-header-fields {
description
"Collection of ICMPv6 header fields that can be
used to set up a match filter.";
leaf type {
type iana-icmpv6-types:icmpv6-type;
description
"Also known as control messages.";
reference
"RFC 4443: Internet Control Message Protocol (ICMPv6)
for Internet Protocol Version 6 (IPv6)
Specification.";
}
leaf code {
type uint8;
description
"ICMP code.";
reference
"RFC 4443: Internet Control Message Protocol (ICMPv6)
for Internet Protocol Version 6 (IPv6)
Specification.";
}
leaf rest-of-header {
type binary;
description
"Unbounded in length, the contents vary based on the
ICMP type and code. Also referred to as 'Message Body'
in ICMPv6.";
reference
"RFC 4443: Internet Control Message Protocol (ICMPv6)
for Internet Protocol Version 6 (IPv6)
Specification.";
}
}
grouping acl-complementary-actions {
description
"Collection of complementary ACL actions.";
container log-action {
description
"Container for defining log actions.";
leaf log-type {
type identityref {
base acl-enh:log-types;
}
description
"The type of log action to be performed.";
}
leaf log-id {
when "derived-from-or-self(../log-type, "
+ "'acl-enh:local-log')" {
description
"Name of the log file updated when type is 'local-log'.";
}
type string;
description
"The name of the counter action.";
}
}
container counter-action {
description
"Container for defining counter actions.";
leaf counter-type {
type identityref {
base acl-enh:counter-type;
}
description
"The type of counter action to be performed.";
}
leaf-list counter-name {
when "derived-from-or-self(../counter-type, "
+ "'acl-enh:counter-name')" {
description
"Name for the counter or variable to update when
'counter-type' is 'counter-name'.";
}
type string;
description
"List of possible variables or counter names to
update based on match critieria.";
}
}
}
grouping ipv4-prefix-sets {
description
"Data definitions for a list of IPv4 prefixes
prefixes which are matched as part of a policy.";
list prefix-set {
key "name";
description
"List of the defined prefix sets.";
leaf name {
type string;
description
"Name of the prefix set -- this is used as a label to
reference the set in match conditions.";
}
leaf description {
type string;
description
"Defined Set description.";
}
leaf-list prefix {
type inet:ipv4-prefix;
description
"List of IPv4 prefixes to be used in match
conditions.";
}
}
}
grouping ipv6-prefix-sets {
description
"Data definitions for a list of IPv6 prefixes which are
matched as part of a policy.";
list prefix-set {
key "name";
description
"List of the defined prefix sets.";
leaf name {
type string;
description
"Name of the prefix set -- this is used as a label to
reference the set in match conditions.";
}
leaf description {
type string;
description
"A textual description of the prefix list.";
}
leaf-list prefix {
type inet:ipv6-prefix;
description
"List of IPv6 prefixes to be used in match conditions.";
}
}
}
grouping port-sets {
description
"Data definitions for a list of ports which can
be matched in policies.";
list port-set {
key "name";
description
"List of port set definitions.";
leaf name {
type string;
description
"Name of the port set -- this is used as a label to
reference the set in match conditions.";
}
list port {
key "id";
description
"Port numbers along with the operator on which to
match.";
leaf id {
type string;
description
"Identifier of the list of port numbers.";
}
choice port {
description
"Choice of specifying the port number or referring to a
group of port numbers.";
container port-range-or-operator {
description
"Indicates a set of ports.";
uses packet-fields:port-range-or-operator;
}
}
}
}
}
grouping protocol-sets {
description
"Data definitions for a list of protocols which can be
matched in policies.";
list protocol-set {
key "name";
description
"List of protocol set definitions.";
leaf name {
type string;
description
"Name of the protocols set -- this is used as a
label to reference the set in match conditions.";
}
leaf-list protocol {
type union {
type uint8;
type string;
}
description
"Value of the protocol set.";
}
}
}
grouping icmpv4-type-sets {
description
"Data definitions for a list of ICMPv4 types which can be
matched in policies.";
list set {
key "name";
description
"List of ICMPv4 type set definitions.";
leaf name {
type string;
description
"Name of the ICMPv4 type set -- this is used as a label
to reference the set in match conditions.";
}
list icmpv4-type {
key "type";
description
"Includes a list of ICMPv4 types.";
uses icmpv4-header-fields;
}
}
}
grouping icmpv6-type-sets {
description
"Data definitions for a list of ICMPv6 types which can be
matched in policies.";
list set {
key "name";
description
"List of ICMP type set definitions.";
leaf name {
type string;
description
"Name of the ICMPv6 type set -- this is used as a label
to reference the set in match conditions.";
}
list icmpv6-type {
key "type";
description
"Includes a list of ICMPv6 types.";
uses icmpv6-header-fields;
}
}
}
grouping aliases {
description
"Grpuing for a set of aliases.";
list alias {
key "name";
description
"List of aliases.";
leaf name {
type string;
description
"The name of the alias.";
}
uses alias;
}
}
grouping defined-sets {
description
"Predefined sets of attributes used in policy match
statements.";
container ipv4-prefix-sets {
description
"Data definitions for a list of IPv4 or IPv6
prefixes which are matched as part of a policy.";
uses ipv4-prefix-sets;
}
container ipv6-prefix-sets {
description
"Data definitions for a list of IPv6 prefixes which are
matched as part of a policy.";
uses ipv6-prefix-sets;
}
container port-sets {
description
"Data definitions for a list of ports which can
be matched in policies.";
uses port-sets;
}
container protocol-sets {
description
"Data definitions for a list of protocols which can be
matched in policies.";
uses protocol-sets;
}
container icmpv4-type-sets {
description
"Data definitions for a list of ICMPv4 types which can be
matched in policies.";
uses icmpv4-type-sets;
}
container icmpv6-type-sets {
description
"Data definitions for a list of ICMPv6 types which can be
matched in policies.";
uses icmpv6-type-sets;
}
container aliases {
description
"Top-level container for aliases.";
uses aliases;
}
}
augment "/acl:acls" {
description
"predefined sets.";
container defined-sets {
description
"Predefined sets of attributes used in policy match
statements.";
uses defined-sets;
}
}
augment "/acl:acls/acl:acl/acl:aces/acl:ace"
+ "/acl:matches" {
description
"Adds a match type based on the payload.";
choice payload {
description
"Matches based upon a prefix pattern.";
container pattern {
if-feature "match-on-payload";
description
"Indicates the rule to perform the payload-based match.";
uses payload-match;
}
}
choice alias {
description
"Matches based upon aliases.";
leaf-list alias-name {
type alias-ref;
description
"Indicates one or more aliases.";
}
}
choice mpls {
description
"Matches against MPLS headers, for example, label
values";
container mpls-values {
if-feature "match-on-mpls";
description
"Provides the rule set that matches MPLS headers.";
uses mpls-match-parameters-config;
}
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l2" {
description
"Adds a match type based on MAC VLAN and I-SID filters.";
container vlan-filter {
if-feature "match-on-vlan-filter";
description
"Indicates how to handle MAC VLANs.";
leaf frame-type {
type string;
description
"Entering the frame type allows the
filter to match a specific type of frame format";
}
choice vlan-type {
description
"VLAN definition from range or operator.";
case range {
leaf lower-vlan {
type uint16;
must '. <= ../upper-vlan' {
error-message
"The lower-vlan must be less than or equal to
the upper-vlan.";
}
mandatory true;
description
"Lower boundary for a VLAN.";
}
leaf upper-vlan {
type uint16;
mandatory true;
description
"Upper boundary for a VLAN.";
}
}
case operator {
leaf operator {
type packet-fields:operator;
default "eq";
description
"Operator to be applied on the VLAN below.";
}
leaf-list vlan {
type uint16;
description
"VLAN number along with the operator on which to
match.";
reference
"IEEE Std 802.1Q: Bridges and Bridged Networks";
}
}
}
}
container isid-filter {
if-feature "match-on-isid-filter";
description
"Indicates how to handle I-SID filters.
The I-component is responsible for mapping customer
Ethernet traffic to the appropriate I-SID.";
choice isid-type {
description
"I-SID definition from range or operator.";
case range {
leaf lower-isid {
type uint16;
must '. <= ../upper-isid' {
error-message
"The lower-isid must be less than or equal to
the upper-isid.";
}
mandatory true;
description
"Lower boundary for an I-SID.";
}
leaf upper-isid {
type uint16;
mandatory true;
description
"Upper boundary for an I-SID.";
}
}
case operator {
leaf operator {
type packet-fields:operator;
default "eq";
description
"Operator to be applied on the I-SID below.";
}
leaf-list isid {
type uint16;
description
"I-SID number along with the operator on which to
match.";
reference
"IEEE 802.1ah: Provider Backbone Bridges";
}
}
}
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l3/acl:ipv4/acl:ipv4" {
description
"Handle non-initial and initial fragments for IPv4 packets.";
container ipv4-fragment {
must 'not(../acl:flags)' {
error-message
"Either flags or fragment should be provided, but not
both.";
}
description
"Indicates how to handle IPv4 fragments.";
uses fragment-fields;
}
leaf source-ipv4-prefix-list {
type ipv4-prefix-set-ref;
description
"A reference to an IPv4 prefix list to match the source
address.";
}
leaf destination-ipv4-prefix-list {
type ipv4-prefix-set-ref;
description
"A reference to a prefix list to match the destination
address.";
}
leaf next-header-set {
type protocol-set-ref;
description
"A reference to a protocol set to match the next-header
field.";
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l3/acl:ipv6/acl:ipv6" {
description
"Handles non-initial and initial fragments for IPv6 packets.";
container ipv6-fragment {
description
"Indicates how to handle IPv6 fragments.";
uses fragment-fields;
}
leaf source-ipv6-prefix-list {
type ipv6-prefix-set-ref;
description
"A reference to a prefix list to match the source address.";
}
leaf destination-ipv6-prefix-list {
type ipv6-prefix-set-ref;
description
"A reference to a prefix list to match the destination
address.";
}
leaf protocol-set {
type protocol-set-ref;
description
"A reference to a protocol set to match the protocol field.";
}
leaf extension-header {
type iana-ipv6-ext-types:ipv6-extension-header-type;
description
"IPv6 extension header value.";
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l4/acl:tcp/acl:tcp" {
description
"Handles TCP flags and port sets.";
container flags-bitmask {
must 'not(../acl:flags)' {
error-message
"Either flags or flags-bitmask should be provided, but not
both.";
}
description
"Indicates how to handle TCP flags.";
uses tcp-flags;
}
leaf source-tcp-port-set {
type port-set-ref;
description
"A reference to a port set to match the source port.";
}
leaf destination-tcp-port-set {
type port-set-ref;
description
"A reference to a port set to match the destination port.";
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l4/acl:udp/acl:udp" {
description
"Handle UDP port sets.";
leaf source-udp-port-set {
type port-set-ref;
description
"A reference to a port set to match the source port.";
}
leaf destination-udp-port-set {
type port-set-ref;
description
"A reference to a port set to match the destination port.";
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:matches/acl:l4/acl:icmp/acl:icmp" {
description
"Handle ICMP type sets.";
leaf icmpv4-set {
type icmpv4-type-set-ref;
description
"A reference to an ICMPv4 type set to match the ICMPv4 type
field.";
}
leaf icmpv6-set {
type icmpv6-type-set-ref;
description
"A reference to an ICMPv6 type set to match the ICMPv6 type
field.";
}
}
augment "/acl:acls/acl:acl/acl:aces"
+ "/acl:ace/acl:actions" {
description
"Complementary actions including Rate-limit action.";
uses acl-complementary-actions;
leaf rate-limit {
when "../acl:forwarding = 'acl:accept'" {
description
"Rate-limit valid only when accept action is used.";
}
type decimal64 {
fraction-digits 2;
}
units "bytes per second";
description
"Indicates a rate-limit for the matched traffic.";
}
}
}
<CODE ENDS>¶
This section is modeled after the template described in Section 3.7 of [I-D.ietf-netmod-rfc8407bis].¶
The "ietf-acl-enh" YANG module defines a data model that is designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. These protocols have to use a secure transport layer (e.g., SSH [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and have to use mutual authentication.¶
The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.¶
There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., "config true", which is the default). All writable data nodes are likely to be reasonably sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) and delete operations to these data nodes without proper protection or authentication can have a negative effect on network operations. The following subtrees and data nodes have particular sensitivities/vulnerabilities:¶
These lists specify a set of sets and aliases. Similar to [RFC8519], unauthorized write access to these list can allow intruders to modify the entries so as to permit traffic that should not be permitted, or deny traffic that should be permitted. The former may result in a DoS attack, or compromise a device. The latter may result in a DoS attack.¶
Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. Specifically, the following subtrees and data nodes have particular sensitivities/vulnerabilities:¶
Unauthorized read access of these lists will allow an attacker to identify the actual resources that are bound to ACLs.¶
The document defines a match policy based on a pattern that can be observed in a packet. For example, such a policy can be combined with header-based matches in the context of DDoS mitigation. Filtering based on a pattern match is deterministic for packets with unencrypted data. However, the efficiency for encrypted packets depend on the presence of an unvarying pattern.¶
The YANG modules "iana-icmpv4-types", "iana-icmpv6-types", and "iana-ipv6-ext-types" define a set of types. These nodes are intended to be reused by other YANG modules. Each of these modules by itself does not expose any data nodes that are writable, data nodes that contain read-only state, or RPCs. As such, there are no additional security issues related to these YANG modules that need to be considered.¶
This document requests IANA to register the following URIs in the "ns" subregistry within the "IETF XML Registry" [RFC3688]:¶
URI: urn:ietf:params:xml:ns:yang:ietf-acl-enh Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-icmpv4-types Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-icmpv6-types Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. URI: urn:ietf:params:xml:ns:yang:iana-ipv6-ext-types Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace.¶
This document requests IANA to register the following YANG modules in the "YANG Module Names" subregistry [RFC6020] within the "YANG Parameters" registry.¶
name: ietf-acl-enh namespace: urn:ietf:params:xml:ns:yang:ietf-acl-enh maintained by IANA: N prefix: acl-enh reference: RFC XXXX name: iana-icmpv4-types namespace: urn:ietf:params:xml:ns:yang:iana-icmpv4-types maintained by IANA: Y prefix: iana-icmpv4-types reference: RFC XXXX name: iana-icmpv6-types namespace: urn:ietf:params:xml:ns:yang:iana-icmpv6-types maintained by IANA: Y prefix: iana-icmpv6-types reference: RFC XXXX name: iana-ipv6-ext-types namespace: urn:ietf:params:xml:ns:yang:iana-ipv6-ext-types maintained by IANA: Y prefix: iana-ipv6-ext-types reference: RFC XXXX¶
IANA is requested to create and post the initial version of the "iana-icmpv4-types" YANG module by applying the XSLT stylesheet from Appendix A.1 to the XML version of [IANA-ICMPv4].¶
This document defines the initial version of the IANA-maintained "iana-icmpv4-types" YANG module. The most recent version of the YANG module is available from the "YANG Parameters" registry [IANA-YANG-PARAMETERS].¶
IANA is requested to add this note to the registry [IANA-YANG-PARAMETERS]:¶
New values must not be directly added to the "iana-icmpv4-types" YANG module. They must instead be added to the "ICMP Type Numbers" registry [IANA-ICMPv4].¶
When a value is added to the "ICMP Type Numbers" registry, a new "enum" statement must be added to the "iana-icmpv4-types" YANG module. The "enum" statement, and sub-statements thereof, should be defined:¶
Replicates the name from the registry with all spaces striped.¶
Contains the decimal value of the IANA-assigned value.¶
Is included only if a registration has been deprecated or obsoleted. IANA "deprecated" maps to YANG status "deprecated", and IANA "obsolete" maps to YANG status "obsolete".¶
Replicates the name from the registry.¶
Replicates the reference(s) from the registry with the title of the document(s) added.¶
Unassigned or reserved values are not present in the module.¶
When the "iana-icmpv4-types" YANG module is updated, a new "revision" statement with a unique revision date must be added in front of the existing revision statements.¶
IANA is requested to add this note to "ICMP Type Numbers" [IANA-ICMPv4]:¶
When this registry is modified, the YANG module "iana-icmpv4-types" [IANA_ICMPv4_YANG_URL] must be updated as defined in RFC XXXX.¶
IANA is requested to updated the "Reference" in the "ICMP Type Numbers" registry as follows:¶
IANA is requested to create and post the initial version of the "iana-icmpv6-types" YANG module by applying the XSLT stylesheet from Appendix B.1 to the XML version of [IANA-ICMPv6].¶
This document defines the initial version of the IANA-maintained "iana-icmpv6-types" YANG module. The most recent version of the YANG module is available from the "YANG Parameters" registry [IANA-YANG-PARAMETERS].¶
IANA is requested to add this note to the registry [IANA-YANG-PARAMETERS]:¶
New values must not be directly added to the "iana-icmpv6-types" YANG module. They must instead be added to the "ICMPv6 "type" Numbers" registry [IANA-ICMPv6].¶
When a value is added to the "ICMPv6 "type" Numbers" registry, a new "enum" statement must be added to the "iana-icmpv6-types" YANG module. The "enum" statement, and sub-statements thereof, should be defined:¶
Replicates the name from the registry with all spaces striped.¶
Contains the decimal value of the IANA-assigned value.¶
Is included only if a registration has been deprecated or obsoleted. IANA "deprecated" maps to YANG status "deprecated", and IANA "obsolete" maps to YANG status "obsolete".¶
Replicates the name from the registry.¶
Replicates the reference(s) from the registry with the title of the document(s) added.¶
Unassigned or reserved values are not present in the module.¶
When the "iana-icmpv6-types" YANG module is updated, a new "revision" statement with a unique revision date must be added in front of the existing revision statements.¶
IANA is requested to add this note to "ICMPv6 "type" Numbers" [IANA-ICMPv6]:¶
When this registry is modified, the YANG module "iana-icmpv6-types" [IANA_ICMPv6_YANG_URL] must be updated as defined in RFC XXXX.¶
IANA is requested to updated the "Reference" in the "ICMPv6 "type" Numbers" registry as follows:¶
IANA is requested to create and post the initial version of the "iana-ipv6-ext-types" YANG module by applying the XSLT stylesheet from Appendix C.1 to the XML version of [IANA-IPv6].¶
This document defines the initial version of the IANA-maintained "iana-ipv6-ext-types" YANG module. The most recent version of the YANG module is available from the "YANG Parameters" registry [IANA-YANG-PARAMETERS].¶
IANA is requested to add this note to the registry [IANA-YANG-PARAMETERS]:¶
New values must not be directly added to the "iana-ipv6-ext-types" YANG module. They must instead be added to the "IPv6 Extension Header Types" registry [IANA-IPv6].¶
When a value is added to the "IPv6 Extension Header Types" registry, a new "enum" statement must be added to the "iana-ipv6-ext-types" YANG module. The "enum" statement, and sub-statements thereof, should be defined:¶
Replicates the description from the registry with all spaces striped.¶
Contains the decimal value of the IANA-assigned value.¶
Is included only if a registration has been deprecated or obsoleted. IANA "deprecated" maps to YANG status "deprecated", and IANA "obsolete" maps to YANG status "obsolete".¶
Replicates the description from the registry.¶
Replicates the reference(s) from the registry with the title of the document(s) added.¶
Unassigned or reserved values are not present in the module.¶
When the "iana-ipv6-ext-types" YANG module is updated, a new "revision" statement with a unique revision date must be added in front of the existing revision statements.¶
IANA is requested to add this note to the "IPv6 Extension Header Types" registry [IANA-IPv6]:¶
When this registry is modified, the YANG module "iana-ipv6-ext-types" [IANA_IPV6_YANG_URL] must be updated as defined in RFC XXXX.¶
IANA is requested to updated the "Reference" in the "IPv6 Extension Header Types" registry as follows:¶
<CODE BEGINS>
<?xml version="1.0" encoding="utf-8"?>
<stylesheet
xmlns="http://www.w3.org/1999/XSL/Transform"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:iana="http://www.iana.org/assignments"
xmlns:yin="urn:ietf:params:xml:ns:yang:yin:1"
version="1.0">
<import href="../../../xslt/iana-yinx.xsl"/>
<output method="xml" encoding="utf-8"/>
<strip-space elements="*"/>
<template match="iana:registry[@id='icmp-parameters-types']">
<element name="yin:typedef">
<attribute name="name">icmpv4-type-name</attribute>
<element name="yin:type">
<attribute name="name">enumeration</attribute>
<apply-templates
select="iana:record[not(iana:description = 'Unassigned' or
starts-with(iana:description, 'Reserved') or
starts-with(iana:description, 'RFC3692')) or
contains(iana:description, 'experimental')]"/>
</element>
<element name="yin:description">
<element name="yin:text">
This enumeration type defines mnemonic names and
corresponding numeric values of ICMPv4 types.
</element>
</element>
<element name="yin:reference">
<element name="yin:text">
RFC 2708: IANA Allocation Guidelines For Values In
the Internet Protocol and Related Headers
</element>
</element>
</element>
<element name="yin:typedef">
<attribute name="name">icmpv4-type</attribute>
<element name="yin:type">
<attribute name="name">union</attribute>
<element name="yin:type">
<attribute name="name">uint8</attribute>
</element>
<element name="yin:type">
<attribute name="name">icmpv4-type-name</attribute>
</element>
</element>
<element name="yin:description">
<element name="yin:text">
This type allows reference to an ICMPv4 type using either
the assigned mnemonic name or numeric value.
</element>
</element>
</element>
</template>
<template match="iana:record">
<call-template name="enum">
<with-param name="id">
<choose>
<when test="contains(iana:description, '(Deprecated)')">
<value-of select="translate(normalize-space(
substring-before(iana:description,
'(Deprecated)')),' ','')"/>
</when>
<otherwise>
<value-of select="substring-before(translate(normalize-space
(iana:description),' ',''),'suchasSeamoby')"/>
</otherwise>
</choose>
</with-param>
<with-param name="deprecated"
select="contains(iana:description,
'(Deprecated)')"/>
</call-template>
</template>
</stylesheet>
<CODE ENDS>¶
<CODE BEGINS> file "iana-icmpv4-types@2020-09-25.yang"
module iana-icmpv4-types {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-icmpv4-types";
prefix iana-icmpv4-types;
organization
"Internet Assigned Numbers Authority (IANA)";
contact
"Internet Assigned Numbers Authority
ICANN
12025 Waterfront Drive, Suite 300
Los Angeles, CA 90094
Tel: +1 424 254 5300
<mailto:iana@iana.org>";
description
"This YANG module translates IANA registry 'ICMP Type Numbers' to
YANG derived types.
Copyright (c) 2020 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
The initial version of this YANG module is part of RFC XXXX;
see the RFC itself for full legal notices.
This version of this YANG module was generated from the
corresponding IANA registry using an XSLT stylesheet from the
'iana-yang' project (https://github.com/llhotka/iana-yang).";
reference
"Internet Control Message Protocol (ICMP) Parameters
(https://www.iana.org/assignments/icmp-parameters/)";
revision 2020-09-25 {
description
"Current revision as of the revision date specified in the XML
representation of the registry page.";
reference
"https://www.iana.org/assignments/icmp-parameters/
icmp-parameters.xml";
}
/* Typedefs */
typedef icmpv4-type-name {
type enumeration {
enum EchoReply {
value 0;
description
"Echo Reply";
reference
"RFC 792";
}
enum DestinationUnreachable {
value 3;
description
"Destination Unreachable";
reference
"RFC 792";
}
enum SourceQuench {
value 4;
status deprecated;
description
"Source Quench (Deprecated)";
reference
"- RFC 792
- RFC 6633";
}
enum Redirect {
value 5;
description
"Redirect";
reference
"RFC 792";
}
enum AlternateHostAddress {
value 6;
status deprecated;
description
"Alternate Host Address (Deprecated)";
reference
"RFC 6918";
}
enum Echo {
value 8;
description
"Echo";
reference
"RFC 792";
}
enum RouterAdvertisement {
value 9;
description
"Router Advertisement";
reference
"RFC 1256";
}
enum RouterSolicitation {
value 10;
description
"Router Solicitation";
reference
"RFC 1256";
}
enum TimeExceeded {
value 11;
description
"Time Exceeded";
reference
"RFC 792";
}
enum ParameterProblem {
value 12;
description
"Parameter Problem";
reference
"RFC 792";
}
enum Timestamp {
value 13;
description
"Timestamp";
reference
"RFC 792";
}
enum TimestampReply {
value 14;
description
"Timestamp Reply";
reference
"RFC 792";
}
enum InformationRequest {
value 15;
status deprecated;
description
"Information Request (Deprecated)";
reference
"- RFC 792
- RFC 6918";
}
enum InformationReply {
value 16;
status deprecated;
description
"Information Reply (Deprecated)";
reference
"- RFC 792
- RFC 6918";
}
enum AddressMaskRequest {
value 17;
status deprecated;
description
"Address Mask Request (Deprecated)";
reference
"- RFC 950
- RFC 6918";
}
enum AddressMaskReply {
value 18;
status deprecated;
description
"Address Mask Reply (Deprecated)";
reference
"- RFC 950
- RFC 6918";
}
enum Traceroute {
value 30;
status deprecated;
description
"Traceroute (Deprecated)";
reference
"- RFC 1393
- RFC 6918";
}
enum DatagramConversionError {
value 31;
status deprecated;
description
"Datagram Conversion Error (Deprecated)";
reference
"- RFC 1475
- RFC 6918";
}
enum MobileHostRedirect {
value 32;
status deprecated;
description
"Mobile Host Redirect (Deprecated)";
reference
"- David Johnson <>
- RFC 6918";
}
enum IPv6Where-Are-You {
value 33;
status deprecated;
description
"IPv6 Where-Are-You (Deprecated)";
reference
"- Bill Simpson <mailto:Bill.Simpson&um.cc.umich.edu>
- RFC 6918";
}
enum IPv6I-Am-Here {
value 34;
status deprecated;
description
"IPv6 I-Am-Here (Deprecated)";
reference
"- Bill Simpson <mailto:Bill.Simpson&um.cc.umich.edu>
- RFC 6918";
}
enum MobileRegistrationRequest {
value 35;
status deprecated;
description
"Mobile Registration Request (Deprecated)";
reference
"- Bill Simpson <mailto:Bill.Simpson&um.cc.umich.edu>
- RFC 6918";
}
enum MobileRegistrationReply {
value 36;
status deprecated;
description
"Mobile Registration Reply (Deprecated)";
reference
"- Bill Simpson <mailto:Bill.Simpson&um.cc.umich.edu>
- RFC 6918";
}
enum DomainNameRequest {
value 37;
status deprecated;
description
"Domain Name Request (Deprecated)";
reference
"- RFC 1788
- RFC 6918";
}
enum DomainNameReply {
value 38;
status deprecated;
description
"Domain Name Reply (Deprecated)";
reference
"- RFC 1788
- RFC 6918";
}
enum SKIP {
value 39;
status deprecated;
description
"SKIP (Deprecated)";
reference
"- Tom Markson <mailto:markson&osmosys.incog.com>
- RFC 6918";
}
enum Photuris {
value 40;
description
"Photuris";
reference
"RFC 2521";
}
enum ICMPmessagesutilizedbyexperimentalmobilityprotocols {
value 41;
description
"ICMP messages utilized by experimental mobility protocols
such as Seamoby";
reference
"RFC 4065";
}
enum ExtendedEchoRequest {
value 42;
description
"Extended Echo Request";
reference
"RFC 8335";
}
enum ExtendedEchoReply {
value 43;
description
"Extended Echo Reply";
reference
"RFC 8335";
}
}
description
"This enumeration type defines mnemonic names and corresponding
numeric values of ICMPv4 types.";
reference
"RFC 2708: IANA Allocation Guidelines For Values In the
Internet Protocol and Related Headers";
}
typedef icmpv4-type {
type union {
type uint8;
type icmpv4-type-name;
}
description
"This type allows reference to an ICMPv4 type using either the
assigned mnemonic name or numeric value.";
}
}
<CODE ENDS>¶
<CODE BEGINS>
<?xml version="1.0" encoding="utf-8"?>
<stylesheet
xmlns="http://www.w3.org/1999/XSL/Transform"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:iana="http://www.iana.org/assignments"
xmlns:yin="urn:ietf:params:xml:ns:yang:yin:1"
version="1.0">
<import href="../../../xslt/iana-yinx.xsl"/>
<output method="xml" encoding="utf-8"/>
<strip-space elements="*"/>
<template match="iana:registry[@id='icmpv6-parameters-2']">
<element name="yin:typedef">
<attribute name="name">icmpv6-type-name</attribute>
<element name="yin:type">
<attribute name="name">enumeration</attribute>
<apply-templates
select="iana:record[not(iana:name = 'Unassigned' or
starts-with(iana:name, 'Reserved') or
starts-with(iana:name, 'Private'))]"/>
</element>
<element name="yin:description">
<element name="yin:text">
This enumeration type defines mnemonic names and
corresponding numeric values of ICMPv6 types.
</element>
</element>
<element name="yin:reference">
<element name="yin:text">
RFC 2708: IANA Allocation Guidelines For Values In
the Internet Protocol and Related Headers
</element>
</element>
</element>
<element name="yin:typedef">
<attribute name="name">icmpv6-type</attribute>
<element name="yin:type">
<attribute name="name">union</attribute>
<element name="yin:type">
<attribute name="name">uint8</attribute>
</element>
<element name="yin:type">
<attribute name="name">icmpv6-type-name</attribute>
</element>
</element>
<element name="yin:description">
<element name="yin:text">
This type allows reference to an ICMPv6 type using either
the assigned mnemonic name or numeric value.
</element>
</element>
</element>
</template>
<template match="iana:record">
<call-template name="enum">
<with-param name="id">
<choose>
<when test="contains(iana:name, '(Deprecated)')">
<value-of select="translate(normalize-space(
substring-before(iana:name,
'(Deprecated)')),' ','')"/>
</when>
<otherwise>
<value-of select="substring-before(translate(normalize-space
(iana:description),' ',''),'suchasSeamoby')"/>
</otherwise>
</choose>
</with-param>
<with-param name="description">
<value-of select="concat(iana:name, '.')"/>
</with-param>
<with-param name="deprecated"
select="contains(iana:name,
'(Deprecated)')"/>
</call-template>
</template>
</stylesheet>
<CODE ENDS>¶
<CODE BEGINS> file "iana-icmpv6-types@2023-04-28.yang"
module iana-icmpv6-types {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-icmpv6-types";
prefix iana-icmpv6-types;
organization
"Internet Assigned Numbers Authority (IANA)";
contact
"Internet Assigned Numbers Authority
ICANN
12025 Waterfront Drive, Suite 300
Los Angeles, CA 90094
Tel: +1 424 254 5300
<mailto:iana@iana.org>";
description
"This YANG module translates IANA registry 'ICMPv6 \"type\"
Numbers' to YANG derived types.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
The initial version of this YANG module is part of RFC XXXX;
see the RFC itself for full legal notices.
This version of this YANG module was generated from the
corresponding IANA registry using an XSLT stylesheet from the
'iana-yang' project (https://github.com/llhotka/iana-yang).";
reference
"Internet Control Message Protocol version 6 (ICMPv6) Parameters
(https://www.iana.org/assignments/icmpv6-parameters/)";
revision 2023-04-28 {
description
"Current revision as of the revision date specified in the XML
representation of the registry page.";
reference
"https://www.iana.org/assignments/icmpv6-parameters
/icmpv6-parameters.xml";
}
/* Typedefs */
typedef icmpv6-type-name {
type enumeration {
enum DestinationUnreachable {
value 1;
description
"Destination Unreachable.";
reference
"RFC 4443";
}
enum PacketTooBig {
value 2;
description
"Packet Too Big.";
reference
"RFC 4443";
}
enum TimeExceeded {
value 3;
description
"Time Exceeded.";
reference
"RFC 4443";
}
enum ParameterProblem {
value 4;
description
"Parameter Problem.";
reference
"RFC 4443";
}
enum EchoRequest {
value 128;
description
"Echo Request.";
reference
"RFC 4443";
}
enum EchoReply {
value 129;
description
"Echo Reply.";
reference
"RFC 4443";
}
enum MulticastListenerQuery {
value 130;
description
"Multicast Listener Query.";
reference
"RFC 2710";
}
enum MulticastListenerReport {
value 131;
description
"Multicast Listener Report.";
reference
"RFC 2710";
}
enum MulticastListenerDone {
value 132;
description
"Multicast Listener Done.";
reference
"RFC 2710";
}
enum RouterSolicitation {
value 133;
description
"Router Solicitation.";
reference
"RFC 4861";
}
enum RouterAdvertisement {
value 134;
description
"Router Advertisement.";
reference
"RFC 4861";
}
enum NeighborSolicitation {
value 135;
description
"Neighbor Solicitation.";
reference
"RFC 4861";
}
enum NeighborAdvertisement {
value 136;
description
"Neighbor Advertisement.";
reference
"RFC 4861";
}
enum RedirectMessage {
value 137;
description
"Redirect Message.";
reference
"RFC 4861";
}
enum RouterRenumbering {
value 138;
description
"Router Renumbering.";
reference
"RFC 2894";
}
enum ICMPNodeInformationQuery {
value 139;
description
"ICMP Node Information Query.";
reference
"RFC 4620";
}
enum ICMPNodeInformationResponse {
value 140;
description
"ICMP Node Information Response.";
reference
"RFC 4620";
}
enum InverseNeighborDiscoverySolicitationMessage {
value 141;
description
"Inverse Neighbor Discovery Solicitation Message.";
reference
"RFC 3122";
}
enum InverseNeighborDiscoveryAdvertisementMessage {
value 142;
description
"Inverse Neighbor Discovery Advertisement Message.";
reference
"RFC 3122";
}
enum Version2MulticastListenerReport {
value 143;
description
"Version 2 Multicast Listener Report.";
reference
"RFC 3810";
}
enum HomeAgentAddressDiscoveryRequestMessage {
value 144;
description
"Home Agent Address Discovery Request Message.";
reference
"RFC 6275";
}
enum HomeAgentAddressDiscoveryReplyMessage {
value 145;
description
"Home Agent Address Discovery Reply Message.";
reference
"RFC 6275";
}
enum MobilePrefixSolicitation {
value 146;
description
"Mobile Prefix Solicitation.";
reference
"RFC 6275";
}
enum MobilePrefixAdvertisement {
value 147;
description
"Mobile Prefix Advertisement.";
reference
"RFC 6275";
}
enum CertificationPathSolicitationMessage {
value 148;
description
"Certification Path Solicitation Message.";
reference
"RFC 3971";
}
enum CertificationPathAdvertisementMessage {
value 149;
description
"Certification Path Advertisement Message.";
reference
"RFC 3971";
}
enum ICMPmessagesutilizedbyexperimentalmobilityprotocols {
value 150;
description
"ICMP messages utilized by experimental mobility protocols
such as Seamoby.";
reference
"RFC 4065";
}
enum MulticastRouterAdvertisement {
value 151;
description
"Multicast Router Advertisement.";
reference
"RFC 4286";
}
enum MulticastRouterSolicitation {
value 152;
description
"Multicast Router Solicitation.";
reference
"RFC 4286";
}
enum MulticastRouterTermination {
value 153;
description
"Multicast Router Termination.";
reference
"RFC 4286";
}
enum FMIPv6Messages {
value 154;
description
"FMIPv6 Messages.";
reference
"RFC 5568";
}
enum RPLControlMessage {
value 155;
description
"RPL Control Message.";
reference
"RFC 6550";
}
enum ILNPv6LocatorUpdateMessage {
value 156;
description
"ILNPv6 Locator Update Message.";
reference
"RFC 6743";
}
enum DuplicateAddressRequest {
value 157;
description
"Duplicate Address Request.";
reference
"RFC 6775";
}
enum DuplicateAddressConfirmation {
value 158;
description
"Duplicate Address Confirmation.";
reference
"RFC 6775";
}
enum MPLControlMessage {
value 159;
description
"MPL Control Message.";
reference
"RFC 7731";
}
enum ExtendedEchoRequest {
value 160;
description
"Extended Echo Request.";
reference
"RFC 8335";
}
enum ExtendedEchoReply {
value 161;
description
"Extended Echo Reply.";
reference
"RFC 8335";
}
}
description
"This enumeration type defines mnemonic names and corresponding
numeric values of ICMPv6 types.";
reference
"RFC 2708: IANA Allocation Guidelines For Values In the
Internet Protocol and Related Headers";
}
typedef icmpv6-type {
type union {
type uint8;
type icmpv6-type-name;
}
description
"This type allows reference to an ICMPv6 type using either the
assigned mnemonic name or numeric value.";
}
}
<CODE ENDS>¶
<CODE BEGINS>
<?xml version="1.0" encoding="utf-8"?>
<stylesheet
xmlns="http://www.w3.org/1999/XSL/Transform"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:iana="http://www.iana.org/assignments"
xmlns:yin="urn:ietf:params:xml:ns:yang:yin:1"
version="1.0">
<import href="../../../xslt/iana-yinx.xsl"/>
<output method="xml" encoding="utf-8"/>
<strip-space elements="*"/>
<template match="iana:registry[@id='extension-header']">
<element name="yin:typedef">
<attribute name="name">
ipv6-extension-header-type-name
</attribute>
<element name="yin:type">
<attribute name="name">enumeration</attribute>
<apply-templates
select="iana:record[not(iana:description = 'Unassigned' or
starts-with(iana:description, 'Reserved') or
starts-with(iana:description,
'Use for experimentation and testing')) or
contains(iana:description, 'experimental')]"/>
</element>
<element name="yin:description">
<element name="yin:text">
This enumeration type defines mnemonic names and
corresponding numeric values of IPv6 Extension header
types.
</element>
</element>
<element name="yin:reference">
<element name="yin:text">
RFC 2708: IANA Allocation Guidelines For Values In
the Internet Protocol and Related Headers
</element>
</element>
</element>
<element name="yin:typedef">
<attribute name="name">
ipv6-extension-header-type
</attribute>
<element name="yin:type">
<attribute name="name">union</attribute>
<element name="yin:type">
<attribute name="name">uint8</attribute>
</element>
<element name="yin:type">
<attribute name="name">
ipv6-extension-header-type-name
</attribute>
</element>
</element>
<element name="yin:description">
<element name="yin:text">
This type allows reference to an IPv6 Extension
header type using either the assigned mnemonic
name or the numeric protocol number value.
</element>
</element>
</element>
</template>
<template match="iana:record">
<call-template name="enum">
<with-param name="id">
<choose>
<when test="contains(iana:description,
'(Deprecated)')">
<value-of select="translate(normalize-space(
substring-before(iana:description,
'(Deprecated)')),' ','')"/>
</when>
<otherwise>
<value-of select="translate(\
normalize-space(iana:description),' ','')"/>
</otherwise>
</choose>
</with-param>
<with-param name="deprecated"
select="contains(iana:description,
'(Deprecated)')"/>
</call-template>
</template>
</stylesheet>
<CODE ENDS>¶
<CODE BEGINS> file "iana-ipv6-ext-types@2023-09-29.yang"
module iana-ipv6-ext-types {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:iana-ipv6-ext-types";
prefix iana-ipv6-ext-types;
organization
"Internet Assigned Numbers Authority (IANA)";
contact
"Internet Assigned Numbers Authority
ICANN
12025 Waterfront Drive, Suite 300
Los Angeles, CA 90094
Tel: +1 424 254 5300
<mailto:iana@iana.org>";
description
"This YANG module translates IANA registry 'IPv6 Extension Header
Types' to YANG derived types.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module was generated from the
corresponding IANA registry using an XSLT stylesheet from the
'iana-yang' project (https://github.com/llhotka/iana-yang).";
reference
"Internet Protocol Version 6 (IPv6) Parameters
(https://www.iana.org/assignments/ipv6-parameters/)";
revision 2023-09-29 {
description
"Current revision as of the revision date specified in the XML
representation of the registry page.";
reference
"https://www.iana.org/assignments/ipv6-parameters
/ipv6-parameters.xml";
}
/* Typedefs */
typedef ipv6-extension-header-type-name {
type enumeration {
enum IPv6Hop-by-HopOption {
value 0;
description
"IPv6 Hop-by-Hop Option";
reference
"RFC 8200";
}
enum RoutingHeaderforIPv6 {
value 43;
description
"Routing Header for IPv6";
reference
"- RFC 8200
- RFC 5095";
}
enum FragmentHeaderforIPv6 {
value 44;
description
"Fragment Header for IPv6";
reference
"RFC 8200";
}
enum EncapsulatingSecurityPayload {
value 50;
description
"Encapsulating Security Payload";
reference
"RFC 4303";
}
enum AuthenticationHeader {
value 51;
description
"Authentication Header";
reference
"RFC 4302";
}
enum DestinationOptionsforIPv6 {
value 60;
description
"Destination Options for IPv6";
reference
"RFC 8200";
}
enum MobilityHeader {
value 135;
description
"Mobility Header";
reference
"RFC 6275";
}
enum HostIdentityProtocol {
value 139;
description
"Host Identity Protocol";
reference
"RFC 7401";
}
enum Shim6Protocol {
value 140;
description
"Shim6 Protocol";
reference
"RFC 5533";
}
}
description
"This enumeration type defines mnemonic names and
corresponding numeric values of IPv6 Extension header
types.";
reference
"RFC 2708: IANA Allocation Guidelines For Values In the
Internet Protocol and Related Headers";
}
typedef ipv6-extension-header-type {
type union {
type uint8;
type ipv6-extension-header-type-name;
}
description
"This type allows reference to an IPv6 Extension header
type using either the assigned mnemonic name or the
numeric protocol number value.";
}
}
<CODE ENDS>¶
IP prefix-related data nodes, e.g., "destination-ipv4-network" or "destination-ipv6-network", do not support handling a list of IP prefixes, which may then lead to having to support large numbers of ACL entries in a configuration file.¶
The same issue is encountered when ACLs have to be in place to mitigate DDoS attacks that involve a set of sources (e.g., [RFC9132]). The situation is even worse when both a list of sources and destination prefixes are involved in the filtering.¶
Figure 3 shows an example of the required ACL configuration for filtering traffic from two prefixes.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "first-prefix",
"type": "ipv6-acl-type",
"aces": {
"ace": [
{
"name": "my-test-ace",
"matches": {
"ipv6": {
"destination-ipv6-network":
"2001:db8:6401:1::/64",
"source-ipv6-network":
"2001:db8:1234::/96",
"protocol": 17,
"flow-label": 10000
},
"udp": {
"source-port": {
"operator": "lte",
"port": 80
},
"destination-port": {
"operator": "neq",
"port": 1010
}
}
},
"actions": {
"forwarding": "accept"
}
}
]
}
},
{
"name": "second-prefix",
"type": "ipv6-acl-type",
"aces": {
"ace": [
{
"name": "my-test-ace",
"matches": {
"ipv6": {
"destination-ipv6-network":
"2001:db8:6401:c::/64",
"source-ipv6-network":
"2001:db8:1234::/96",
"protocol": 17,
"flow-label": 10000
},
"udp": {
"source-port": {
"operator": "lte",
"port": 80
},
"destination-port": {
"operator": "neq",
"port": 1010
}
}
},
"actions": {
"forwarding": "accept"
}
}
]
}
}
]
}
}
Such a configuration is suboptimal for both:¶
The same approach as the one discussed for IP prefixes can be generalized by introducing the concept of "aliases" or "defined sets".¶
The defined sets are reusable definitions across several ACLs. Each category is modeled in YANG as a list of parameters related to the class it represents. The following sets can be considered:¶
Used to create lists of IPv4 or IPv6 prefixes.¶
Used to create a list of protocols.¶
Used to create lists of TCP or UDP port values (or any other transport protocol that makes uses of port numbers). The identity of the protocols is identified by the protocol set, if present. Otherwise, a set applies to any protocol.¶
Uses to create lists of ICMP-based filters. This applies only when the protocol is set to ICMP or ICMPv6.¶
Aliases may also be considered to manage resources that are identified by a combination of various parameters (e.g., prefix, protocol, port number, FQDN, or VLAN IDs). Note that some aliases can be provided by decomposing them into separate sets.¶
In the context of network management, an ACL may be enforced in many network locations. As such, the ACL module should allow for binding an ACL to multiple devices, not only (abstract) interfaces.¶
The ACL name must, thus, be unique at the scale of the network, but the same name may be used in many devices when enforcing node-specific ACLs.¶
[RFC8519] does not support fragment handling for IPv6 but offers a partial support for IPv4 through the use of 'flags'. Nevertheless, the use of 'flags' is problematic since it does not allow a bitmask to be defined. For example, setting other bits not covered by the 'flags' filtering clause in a packet will allow that packet to get through (because it won't match the ACE).¶
Defining a new IPv4/IPv6 matching field called 'fragment' is thus required to efficiently handle fragment-related filtering rules.¶
[RFC8519] supports including flags in the TCP match fields, however that structure does not support matching operations as those supported in BGP Flow Spec. Defining this field to be defined as a flag bitmask together with a set of operations is meant to efficiently handle TCP flags filtering rules.¶
[RFC8519] specifies that forwarding actions can be 'accept' (i.e., accept matching traffic), 'drop' (i.e., drop matching traffic without sending any ICMP error message), or 'reject' (i.e., drop matching traffic and send an ICMP error message to the source). However, there are situations where the matching traffic can be accepted, but with a rate-limit policy. This capability is not supported by [RFC8519].¶
Some transport protocols use existing protocols (e.g., TCP or UDP) as substrate. The match criteria for such protocols may rely upon the 'protocol' under 'l3', TCP/UDP match criteria, part of the TCP/UDP payload, or a combination thereof. [RFC8519] does not support matching based on the payload.¶
Likewise, the current version of the ACL model does not support filtering of encapsulated traffic.¶
Having a global network view of the ACLs is highly valuable for service providers. An ACL could be defined and applied based on the network topology hierarchy. So, an ACL can be defined at the network level and, then, that same ACL can be used (or referenced to) in several devices (including termination points) within the same network.¶
This network/device ACLs differentiation introduces several new requirements, e.g.:¶
An ACL name can be used at both network and device levels.¶
An ACL content updated at the network level should imply a transaction that updates the relevant content in all the nodes using this ACL.¶
ACLs defined at the device level have a local meaning for the specific node.¶
A device can be associated with a router, a VRF, a logical system, or a virtual node. ACLs can be applied in physical and logical infrastructure.¶
The ACLs could be used to create rules to match MPLS fields on a packet. [RFC8519] does not support such function.¶
This section provides a few examples to illustrate the use of the enhanced ACL module ("ietf-acl-enh").¶
Figure 4 shows an example of the message body of a request to install a filter to discard incoming TCP messages having all flags unset.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "tcp-flags-example",
"aces": {
"ace": [
{
"name": "null-attack",
"matches": {
"tcp": {
"ietf-acl-enh:flags-bitmask": {
"operator": "not any",
"bitmask": 4095
}
}
},
"actions": {
"forwarding": "drop"
}
}
]
}
}
]
}
}
Figure 5 shows the content of a POST request to allow the traffic destined to 198.51.100.0/24 and UDP port number 53, but to drop all fragmented packets. The following ACEs are defined (in this order):¶
"drop-all-fragments" ACE: discards all fragments.¶
"allow-dns-packets" ACE: accepts DNS packets destined to 198.51.100.0/24.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "dns-fragments",
"type": "ipv4-acl-type",
"aces": {
"ace": [
{
"name": "drop-all-fragments",
"matches": {
"ipv4": {
"ietf-acl-enh:ipv4-fragment": {
"operator": "match",
"type": "isf"
}
}
},
"actions": {
"forwarding": "drop"
}
},
{
"name": "allow-dns-packets",
"matches": {
"ipv4": {
"destination-ipv4-network": "198.51.100.0/24"
},
"udp": {
"destination-port": {
"operator": "eq",
"port": 53
}
}
},
"actions": {
"forwarding": "accept"
}
}
]
}
}
]
}
}
Figure 6 shows an example of the body of a POST request to allow the traffic destined to 2001:db8::/32 and UDP port number 53, but to drop all fragmented packets. The following ACEs are defined (in this order):¶
"drop-all-fragments" ACE: discards all fragments (including atomic fragments). That is, IPv6 packets that include a Fragment header (44) are dropped.¶
"allow-dns-packets" ACE: accepts DNS packets destined to 2001:db8::/32.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "dns-fragments",
"type": "ipv6-acl-type",
"aces": {
"ace": [
{
"name": "drop-all-fragments",
"matches": {
"ipv6": {
"ietf-acl-enh:ipv6-fragment": {
"operator": "match",
"type": "isf"
}
}
},
"actions": {
"forwarding": "drop"
}
},
{
"name": "allow-dns-packets",
"matches": {
"ipv6": {
"destination-ipv6-network": "2001:db8::/32"
},
"udp": {
"destination-port": {
"operator": "eq",
"port": 53
}
}
},
"actions": {
"forwarding": "accept"
}
}
]
}
}
]
}
}
Figure 7 shows an ACL example to illustrate how to apply a VLAN range filter.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "VLAN_FILTER",
"aces": {
"ace": [
{
"name": "1",
"matches": {
"ietf-acl-enh:vlan-filter": {
"lower-vlan": 10,
"upper-vlan": 20
}
},
"actions": {
"forwarding": "ietf-access-control-list:accept"
}
}
]
}
}
]
}
}
Figure 8 shows an ACL example to illustrate the ISID range filtering.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "test",
"aces": {
"ace": [
{
"name": "1",
"matches": {
"ietf-acl-enh:isid-filter": {
"lower-isid": 100,
"upper-isid": 200
}
},
"actions": {
"forwarding": "ietf-access-control-list:accept"
}
}
]
}
}
]
}
}
Figure 9 shows an ACL example to rate-limit incoming SYNs during a SYN flood attack.¶
{
"ietf-access-control-list:acls": {
"acl": [
{
"name": "tcp-flags-example-with-rate-limit",
"aces": {
"ace": [
{
"name": "rate-limit-syn",
"matches": {
"tcp": {
"ietf-acl-enh:flags-bitmask": {
"operator": "match",
"bitmask": 2
}
}
},
"actions": {
"forwarding": "accept",
"ietf-acl-enh:rate-limit": "20.00"
}
}
]
}
}
]
}
}
Many thanks to Jon Shallow and Miguel Cros for the review and comments to the document, including prior to publishing the document.¶
Thanks to Qiufang Ma, Victor Lopez, Joe Clarke, and Mahesh Jethanandani for the comments and suggestions.¶
Thanks to Lou Berger for Shepherding the document.¶
Thanks to David Black for the TSV review, Tim Wicinski for the intdir review, and Per Andersson for the yangdoctors review.¶
The IANA-maintained modules were generated using an XSLT stylesheet from the 'iana-yang' project [YANG-XSLT]).¶
This work is partially supported by the European Commission under Horizon 2020 Secured autonomic traffic management for a Tera of SDN flows (Teraflow) project (grant agreement number 101015857).¶