Distributed Denial-of-Service Open Threat Signaling (DOTS) Data Channel Specification Orange
Rennes 35000 France mohamed.boucadair@orange.com
McAfee, Inc.
Embassy Golf Link Business Park Bangalore Karnataka 560071 India kondtir@gmail.com
DOTS Automation Security Mitigation Scrubbing Anti-DDoS Mitigator Security Center Filtering Resilience RESTCONF The document specifies a Distributed Denial-of-Service Open Threat Signaling (DOTS) data channel used for bulk exchange of data that cannot easily or appropriately communicated through the DOTS signal channel under attack conditions. This is a companion document to "Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel Specification" (RFC 8782).
Status of This Memo This is an Internet Standards Track document. This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841. Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at .
Copyright Notice Copyright (c) 2020 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 () 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 Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
Table of Contents
  • .  Introduction
  • .  Terminology
  • .  DOTS Data Channel
    • .  Design Overview
    • .  DOTS Server(s) Discovery
    • .  DOTS Gateways
    • .  Detecting and Preventing Infinite Loops
    • .  Preventing Stale Entries
  • .  DOTS Data Channel YANG Module
    • .  Generic Tree Structure
    • .  Filtering Fields
    • .  YANG Module
  • .  Managing DOTS Clients
    • .  Registering DOTS Clients
    • .  De-registering DOTS Clients
  • .  Managing DOTS Aliases
    • .  Creating Aliases
    • .  Retrieving Installed Aliases
    • .  Deleting Aliases
  • .  Managing DOTS Filtering Rules
    • .  Retrieving DOTS Filtering Capabilities
    • .  Installing Filtering Rules
    • .  Retrieving Installed Filtering Rules
    • .  Removing Filtering Rules
  • .  Operational Considerations
  • .  IANA Considerations
  • . Security Considerations
  • . References
    • .  Normative References
    • .  Informative References
  • .  Examples: Filtering Fragments
  • .  Examples: Filtering TCP Messages
    • .  Discard TCP Null Attack
    • .  Rate-Limit SYN Flooding
    • .  Rate-Limit ACK Flooding
  • Acknowledgements
  • Contributors
  • Authors' Addresses
Introduction A distributed denial-of-service (DDoS) attack is an attempt to make machines or network resources unavailable to their intended users. In most cases, sufficient scale can be achieved by compromising enough end hosts and using those infected hosts to perpetrate and amplify the attack. The victim of such an attack can be an application server, a router, a firewall, an entire network, etc. As discussed in , the lack of a common method to coordinate a real-time response among involved actors and network domains inhibits the speed and effectiveness of DDoS attack mitigation. From that standpoint, DDoS Open Threat Signaling (DOTS) defines an architecture that allows a DOTS client to send requests to a DOTS server for DDoS attack mitigation . The DOTS approach is thus meant to minimize the impact of DDoS attacks, thereby contributing to the enforcement of more efficient defensive if not proactive security strategies. To that aim, DOTS defines two channels: the signal channel and the data channel ().
DOTS Channels +---------------+ +---------------+ | | <------- Signal Channel ------> | | | DOTS Client | | DOTS Server | | | <======= Data Channel ======> | | +---------------+ +---------------+
The DOTS signal channel is used to carry information about a device or a network (or a part thereof) that is under a DDoS attack. Such information is sent by a DOTS client to an upstream DOTS server so that appropriate mitigation actions are undertaken on traffic deemed suspicious. The DOTS signal channel is further elaborated in . The DOTS data channel is used for infrequent bulk data exchange between DOTS agents to significantly improve the coordination of all the parties involved in the response to the attack. mentions that the DOTS data channel is used to perform the following tasks:
  • Creation of aliases for resources for which mitigation may be requested. A DOTS client may submit to its DOTS server a collection of prefixes to which it would like to refer by an alias when requesting mitigation. The DOTS server can respond to this request with either a success or failure response (see ). Refer to for more details.
  • Policy management, which enables a DOTS client to request the installation or withdrawal of traffic filters, the dropping or rate-limiting of unwanted traffic, and the permitting of accept-listed traffic. A DOTS client is entitled to instruct filtering rules only on IP resources that belong to its domain. Sample use cases for populating drop- or accept-list filtering rules are detailed hereafter:
    • If a network resource (DOTS client) is informed about a potential DDoS attack from a set of IP addresses, the DOTS client informs its servicing DOTS gateway of all suspect IP addresses that need to be drop-listed for further investigation. The DOTS client could also specify a list of protocols and port numbers in the drop-list rule. The DOTS gateway then propagates the drop-listed IP addresses to a DOTS server, which will undertake appropriate actions so that traffic originated by these IP addresses to the target network (specified by the DOTS client) is blocked.
    • A network that has partner sites from which only legitimate traffic arrives may want to ensure that the traffic from these sites is not subjected to DDoS attack mitigation. The DOTS client uses the DOTS data channel to convey the accept-listed IP prefixes of the partner sites to its DOTS server. The DOTS server uses this information to accept-list flows originated by such IP prefixes and which reach the network.
    Refer to for more details.
Terminology 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 when, and only when, they appear in all capitals, as shown here. The reader should be familiar with the terms defined in . The terminology for describing YANG modules is defined in . The meaning of the symbols in the tree diagrams is defined in . This document generalizes the notion of Access Control List (ACL) so that it is not device specific . As such, this document defines an ACL as an ordered set of rules that is used to filter traffic. Each rule is represented by an Access Control Entry (ACE). ACLs communicated via the DOTS data channel are not bound to a device interface. For the sake of simplicity, the examples in this document use "/restconf" as the discovered RESTCONF API root path. Within the examples, many protocol header lines and message-body text are split into multiple lines for display purposes only. When a line ends with backslash ('\') as the last character, the line is wrapped for display purposes. It is to be considered to be joined to the next line by deleting the backslash, the following line break, and the leading whitespace of the next line.
DOTS Data Channel
Design Overview Unlike the DOTS signal channel, which must remain operational even when confronted with signal degradation due to packet loss, the DOTS data channel is not expected to be fully operational at all times, especially when a DDoS attack is underway. The requirements for a DOTS data channel protocol are documented in . This specification does not require an order of DOTS signal and data channel creation nor does it mandate a time interval between them. These considerations are implementation and deployment specific. As the primary function of the data channel is data exchange, a reliable transport mode is required in order for DOTS agents to detect data delivery success or failure. This document uses RESTCONF over TLS over TCP as the DOTS data channel protocol. The abstract layering of the DOTS data channel is shown in .
Abstract Layering of DOTS Data Channel +-------------------+ | DOTS Data Channel | +-------------------+ | RESTCONF | +-------------------+ | TLS | +-------------------+ | TCP | +-------------------+ | IP | +-------------------+
The HTTP POST, PUT, PATCH, and DELETE methods are used to edit data resources represented by DOTS data channel YANG modules. These basic edit operations allow a DOTS client to alter the running configuration of the DOTS data channel. Rules for generating and processing RESTCONF methods are defined in . DOTS data channel configuration information as well as state information can be retrieved with the GET method. An HTTP status-line is returned for each request to report success or failure for RESTCONF operations (). The error-tag provides more information about encountered errors (). DOTS clients perform the root resource discovery procedure discussed in to determine the root of the RESTCONF API. After discovering the RESTCONF API root, a DOTS client uses this value as the initial part of the path in the request URI in any subsequent request to the DOTS server. The DOTS server may support the retrieval of the YANG modules it supports (). For example, a DOTS client may use RESTCONF to retrieve the vendor-specific YANG modules supported by its DOTS server. JavaScript Object Notation (JSON) payloads are used to propagate the DOTS data-channel-specific payload messages that carry request parameters and response information, such as errors. This specification uses the encoding rules defined in for representing DOTS data channel configuration data using YANG () as JSON text. A DOTS client registers itself with its DOTS server(s) in order to set up DOTS data channel-related configuration data and to receive state data (i.e., non-configuration data) from the DOTS server(s) (). Mutual authentication considerations are specified in . The coupling of signal and data channels is discussed in . A DOTS client can either maintain a persistent connection or initiate periodic connections with its DOTS server(s). If the DOTS client needs to frequently update the drop-list or accept-list filtering rules or aliases, it maintains a persistent connection with the DOTS server. For example, CAPTCHA and cryptographic puzzles can be used by the mitigation service in the DOTS client domain to determine whether or not the IP address is used for legitimate purpose, and the DOTS client can frequently update the drop-list filtering rules. A persistent connection is also useful if the DOTS client subscribes to event notifications (). Additional considerations related to RESTCONF connection management (including, configuring the connection type or the reconnect strategy) can be found in . A single DOTS data channel between DOTS agents can be used to exchange multiple requests and multiple responses. To reduce DOTS client and DOTS server workload, DOTS clients SHOULD reuse the same TLS session. While the communication to the DOTS server is quiescent, the DOTS client MAY probe the server to ensure it has maintained cryptographic state. Such probes can also keep alive firewall and/or NAT bindings. A TLS heartbeat verifies that the DOTS server still has TLS state by returning a TLS message. A DOTS server may detect conflicting filtering requests from distinct DOTS clients that belong to the same domain. For example, a DOTS client could request to drop-list a prefix by specifying the source prefix, while another DOTS client could request to accept-list that same source prefix, but both having the same destination prefix. DOTS servers SHOULD support a configuration parameter to indicate the behavior to follow when a conflict is detected (e.g., reject all, reject the new request, notify an administrator for validation). specifies a default behavior when no instruction is supplied to a DOTS server. How a DOTS client synchronizes its configuration with the one maintained by its DOTS server(s) is implementation specific. For example:
  • A DOTS client can systematically send a GET message before and/or after a configuration change request.
  • A DOTS client can reestablish the disconnected DOTS session after an attack is mitigated. Then, it sends a GET message before a configuration change request.
NAT considerations for the DOTS data channel are similar to those discussed in . The translation of filtering rules instantiated on a DOTS server into network configuration actions is out of scope of this specification. Some of the fields introduced in are also discussed in Sections , , and . These sections are authoritative for these fields.
DOTS Server(s) Discovery This document assumes that DOTS clients are provisioned with the knowledge of how to reach their DOTS server(s), which could occur by a variety of means (e.g., local configuration or dynamic means such as DHCP ). The specification of such means are out of scope of this document. Likewise, it is out of scope of this document to specify the behavior to be followed by a DOTS client to send DOTS requests when multiple DOTS servers are provisioned (e.g., contact all DOTS servers, select one DOTS server among the list).
DOTS Gateways When a server-domain DOTS gateway is involved in DOTS data channel exchanges, the same considerations for manipulating the 'cdid' (client domain identifier) parameter specified in MUST be followed by DOTS agents. As a reminder, 'cdid' is meant to assist the DOTS server in enforcing some policies (e.g., limit the number of filtering rules per DOTS client or per DOTS client domain). A loop detection mechanism for DOTS gateways is specified in . If a DOTS gateway is involved, the DOTS gateway verifies that the DOTS client is authorized to undertake a data channel action (e.g., instantiate filtering rules). If the DOTS client is authorized, it propagates the rules to the upstream DOTS server. Likewise, the DOTS server verifies that the DOTS gateway is authorized to relay data channel actions. For example, to create or purge filters, a DOTS client sends its request to its DOTS gateway. The DOTS gateway validates the rules in the request and proxies the requests containing the filtering rules to its DOTS server. When the DOTS gateway receives the associated response from the DOTS server, it propagates the response back to the DOTS client.
Detecting and Preventing Infinite Loops In order to detect and prevent infinite loops, DOTS gateways MUST support the procedure defined in . In particular, each intermediate DOTS gateway MUST check that none of its own information (e.g., server names, literal IP addresses) is present in the Via header field of a DOTS message it receives:
  • If it detects that its own information is present in the Via header field, the DOTS gateway MUST NOT forward the DOTS message. Messages that cannot be forwarded because of a loop SHOULD be logged with a "508 Loop Detected" status-line returned to the DOTS peer. The structure of the reported error is depicted in .
    Loop Detected Error error-app-tag: loop-detected error-tag: operation-failed error-type: transport, application error-info: <via-header> : A copy of the Via header field when the loop was detected. Description: An infinite loop has been detected when forwarding a requests via a proxy.
    It is RECOMMENDED that DOTS clients and gateways support methods to alert administrators about loop errors so that appropriate actions are undertaken.
  • Otherwise, the DOTS agent MUST update or insert the Via header field by appending its own information.
Unless configured otherwise, DOTS gateways at the boundaries of a DOTS client domain SHOULD remove the previous Via header field information after checking for a loop before forwarding. This behavior is required for topology hiding purposes but can also serve to minimize potential conflicts that may arise if overlapping information is used in distinct DOTS domains (e.g., private IPv4 addresses, aliases that are not globally unique).
Preventing Stale Entries In order to avoid stale entries, a lifetime is associated with alias and filtering entries created by DOTS clients. Also, DOTS servers may track the inactivity timeout of DOTS clients to detect stale entries.
DOTS Data Channel YANG Module
Generic Tree Structure The DOTS data channel YANG module 'ietf-dots-data-channel' provides a method for DOTS clients to manage aliases for resources for which mitigation may be requested. Such aliases may be used in subsequent DOTS signal channel exchanges to refer more efficiently to the resources under attack. Note that the full module's tree has been split across several figures to aid the exposition of the various subtrees. The tree structure for the DOTS alias is depicted in .
DOTS Alias Subtree module: ietf-dots-data-channel +--rw dots-data +--rw dots-client* [cuid] | +--rw cuid string | +--rw cdid? string | +--rw aliases | | +--rw alias* [name] | | +--rw name string | | +--rw target-prefix* inet:ip-prefix | | +--rw target-port-range* [lower-port] | | | +--rw lower-port inet:port-number | | | +--rw upper-port? inet:port-number | | +--rw target-protocol* uint8 | | +--rw target-fqdn* inet:domain-name | | +--rw target-uri* inet:uri | | +--ro pending-lifetime? int32 | +--rw acls | ... +--ro capabilities ...
Also, the 'ietf-dots-data-channel' YANG module provides a method for DOTS clients to manage filtering rules. Examples of filtering management in a DOTS context include, but are not limited to:
  • Drop-list management, which enables a DOTS client to inform a DOTS server about sources from which traffic should be discarded.
  • Accept-list management, which enables a DOTS client to inform a DOTS server about sources from which traffic should always be accepted.
  • Policy management, which enables a DOTS client to request the installation or withdrawal of traffic filters, the dropping or rate-limiting of unwanted traffic, and the allowance of accept-listed traffic.
The tree structure for the DOTS filtering entries is depicted in . Investigations into the prospect of augmenting 'ietf-access-control-list' to meet DOTS requirements concluded that such a design approach did not support many of the DOTS requirements, for example:
  • Retrieve a filtering entry (or all entries) created by a DOTS client.
  • Delete a filtering entry that was instantiated by a DOTS client.
Accordingly, new DOTS filtering entries (i.e., ACL) are defined that mimic the structure specified in . Concretely, DOTS agents are assumed to manipulate an ordered list of ACLs; each ACL contains a separately ordered list of ACEs. Each ACE has a group of match and a group of action criteria. Once all of the ACE entries have been iterated though with no match, then all of the following ACL's ACE entries are iterated through until the first match, at which point the specified action is applied. If there is no match during 'idle' time (i.e., no mitigation is active), then there is no further action to be taken against the packet. If there is no match during active mitigation, then the packet will still be scrubbed by the DDoS mitigator.
DOTS ACLs Subtree module: ietf-dots-data-channel +--rw dots-data +--rw dots-client* [cuid] | +--rw cuid string | +--rw cdid? string | +--rw aliases | | ... | +--rw acls | +--rw acl* [name] | +--rw name string | +--rw type? ietf-acl:acl-type | +--rw activation-type? activation-type | +--ro pending-lifetime? int32 | +--rw aces | +--rw ace* [name] | +--rw name string | +--rw matches | | +--rw (l3)? | | | +--:(ipv4) | | | | ... | | | +--:(ipv6) | | | ... | | +--rw (l4)? | | +--:(tcp) | | | ... | | +--:(udp) | | | ... | | +--:(icmp) | | ... | +--rw actions | | +--rw forwarding identityref | | +--rw rate-limit? decimal64 | +--ro statistics | +--ro matched-packets? yang:counter64 | +--ro matched-octets? yang:counter64 +--ro capabilities ...
Filtering rules instructed by a DOTS client assume a default direction: the destination is the DOTS client domain. DOTS forwarding actions can be 'accept' (i.e., accept matching traffic) or 'drop' (i.e., drop matching traffic without sending any ICMP error message). Accepted traffic can be subject to rate-limiting 'rate-limit'. Note that 'reject' action (i.e., drop matching traffic and send an ICMP error message to the source) is not supported in 'ietf-dots-data-channel' because it is not appropriate in the context of DDoS mitigation. Generating ICMP messages to notify of drops when mitigating a DDoS attack will exacerbate the DDoS attack. Furthermore, these ICMP messages will be used by an attacker as an explicit signal that the traffic is being blocked.
Filtering Fields The 'ietf-dots-data-channel' module reuses the packet fields module 'ietf-packet-fields' , which defines matching on fields in the packet including IPv4, IPv6, and transport layer fields. The 'ietf-dots-data-channel' module can be augmented, for example, to support additional protocol-specific matching fields. This specification defines a new IPv4/IPv6 matching field called 'fragment' to efficiently handle fragment-related filtering rules. Indeed, does not support such capability for IPv6 but offers a partial support for IPv4 by means 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). Examples to illustrate how 'fragment' can be used are provided in . shows the IPv4 match subtree.
DOTS ACLs Subtree (IPv4 Match) module: ietf-dots-data-channel +--rw dots-data +--rw dots-client* [cuid] | ... | +--rw acls | +--rw acl* [name] | ... | +--rw aces | +--rw ace* [name] | +--rw name string | +--rw matches | | +--rw (l3)? | | | +--:(ipv4) | | | | +--rw ipv4 | | | | +--rw dscp? inet:dscp | | | | +--rw ecn? uint8 | | | | +--rw length? uint16 | | | | +--rw ttl? uint8 | | | | +--rw protocol? uint8 | | | | +--rw ihl? uint8 | | | | +--rw flags? bits | | | | +--rw offset? uint16 | | | | +--rw identification? uint16 | | | | +--rw (destination-network)? | | | | | +--:(destination-ipv4-network) | | | | | +--rw destination-ipv4-network? | | | | | inet:ipv4-prefix | | | | +--rw (source-network)? | | | | | +--:(source-ipv4-network) | | | | | +--rw source-ipv4-network? | | | | | inet:ipv4-prefix | | | | +--rw fragment | | | | +--rw operator? operator | | | | +--rw type fragment-type | | | +--:(ipv6) | | | ... | | +--rw (l4)? | | ... | +--rw actions | | ... | +--ro statistics | ... +--ro capabilities ...
shows the IPv6 match subtree.
DOTS ACLs Subtree (IPv6 Match) module: ietf-dots-data-channel +--rw dots-data +--rw dots-client* [cuid] | ... | +--rw acls | +--rw acl* [name] | ... | +--rw aces | +--rw ace* [name] | +--rw name string | +--rw matches | | +--rw (l3)? | | | +--:(ipv4) | | | | ... | | | +--:(ipv6) | | | +--rw ipv6 | | | +--rw dscp? inet:dscp | | | +--rw ecn? uint8 | | | +--rw length? uint16 | | | +--rw ttl? uint8 | | | +--rw protocol? uint8 | | | +--rw (destination-network)? | | | | +--:(destination-ipv6-network) | | | | +--rw destination-ipv6-network? | | | | inet:ipv6-prefix | | | +--rw (source-network)? | | | | +--:(source-ipv6-network) | | | | +--rw source-ipv6-network? | | | | inet:ipv6-prefix | | | +--rw flow-label? | | | | inet:ipv6-flow-label | | | +--rw fragment | | | +--rw operator? operator | | | +--rw type fragment-type | | +--rw (l4)? | | ... | +--rw actions | | ... | +--ro statistics | ... +--ro capabilities ...
shows the TCP match subtree. In addition to the fields defined in , this specification defines a new TCP matching field, called 'flags-bitmask', to efficiently handle TCP flags filtering rules. Some examples are provided in .
DOTS ACLs Subtree (TCP Match) +--rw matches | +--rw (l3)? | | ... | +--rw (l4)? | +--:(tcp) | | +--rw tcp | | +--rw sequence-number? uint32 | | +--rw acknowledgement-number? uint32 | | +--rw data-offset? uint8 | | +--rw reserved? uint8 | | +--rw flags? bits | | +--rw window-size? uint16 | | +--rw urgent-pointer? uint16 | | +--rw options? binary | | +--rw flags-bitmask | | | +--rw operator? operator | | | +--rw bitmask uint16 | | +--rw (source-port)? | | | +--:(source-port-range-or-operator) | | | +--rw source-port-range-or-operator | | | +--rw (port-range-or-operator)? | | | +--:(range) | | | | +--rw lower-port | | | | | inet:port-number | | | | +--rw upper-port | | | | inet:port-number | | | +--:(operator) | | | +--rw operator? | | | | operator | | | +--rw port | | | inet:port-number | | +--rw (destination-port)? | | +--:(destination-port-range-or-operator) | | +--rw destination-port-range-or-operator | | +--rw (port-range-or-operator)? | | +--:(range) | | | +--rw lower-port | | | | inet:port-number | | | +--rw upper-port | | | inet:port-number | | +--:(operator) | | +--rw operator? | | | operator | | +--rw port | | inet:port-number | +--:(udp) | | ... | +--:(icmp) | ... +--rw actions | ...
shows the UDP and ICMP match subtrees. The same structure is used for both ICMP and ICMPv6. The indication whether an ACL is about ICMP or ICMPv6 is governed by the 'l3' match or the ACL type.
DOTS ACLs Subtree (UDP and ICMP Match) +--rw matches | +--rw (l3)? | | ... | +--rw (l4)? | +--:(tcp) | | ... | +--:(udp) | | +--rw udp | | +--rw length? uint16 | | +--rw (source-port)? | | | +--:(source-port-range-or-operator) | | | +--rw source-port-range-or-operator | | | +--rw (port-range-or-operator)? | | | +--:(range) | | | | +--rw lower-port | | | | | inet:port-number | | | | +--rw upper-port | | | | inet:port-number | | | +--:(operator) | | | +--rw operator? | | | | operator | | | +--rw port | | | inet:port-number | | +--rw (destination-port)? | | +--:(destination-port-range-or-operator) | | +--rw destination-port-range-or-operator | | +--rw (port-range-or-operator)? | | +--:(range) | | | +--rw lower-port | | | | inet:port-number | | | +--rw upper-port | | | inet:port-number | | +--:(operator) | | +--rw operator? | | | operator | | +--rw port | | inet:port-number | +--:(icmp) | +--rw icmp | +--rw type? uint8 | +--rw code? uint8 | +--rw rest-of-header? binary +--rw actions | ...
DOTS implementations MUST support the following matching criteria:
  • Match based on the IP header (IPv4 and IPv6), match based on the transport header (TCP, UDP, and ICMP), and match based on any combination thereof. The same matching fields are used for both ICMP and ICMPv6.
The following match fields MUST be supported by DOTS implementations (): Mandatory DOTS Channel Match Fields
ACL Match Mandatory Fields
ipv4 length, protocol, destination-ipv4-network, source-ipv4-network, and fragment
ipv6 length, protocol, destination-ipv6-network, source-ipv6-network, and fragment
tcp flags-bitmask, source-port-range-or-operator, and destination-port-range-or-operator
udp length, source-port-range-or-operator, and destination-port-range-or-operator
icmp type and code
Implementations MAY support other filtering match fields and actions. The 'ietf-dots-data-channel' YANG module provides a method for an implementation to expose its filtering capabilities. The tree structure of the 'capabilities' is shown in . DOTS clients that support both 'fragment' and 'flags' (or 'flags-bitmask' and 'flags') matching fields MUST NOT set these fields in the same request.
Filtering Capabilities Subtree module: ietf-dots-data-channel +--rw dots-data ... +--ro capabilities +--ro address-family* enumeration +--ro forwarding-actions* identityref +--ro rate-limit? boolean +--ro transport-protocols* uint8 +--ro ipv4 | +--ro dscp? boolean | +--ro ecn? boolean | +--ro length? boolean | +--ro ttl? boolean | +--ro protocol? boolean | +--ro ihl? boolean | +--ro flags? boolean | +--ro offset? boolean | +--ro identification? boolean | +--ro source-prefix? boolean | +--ro destination-prefix? boolean | +--ro fragment? boolean +--ro ipv6 | +--ro dscp? boolean | +--ro ecn? boolean | +--ro length? boolean | +--ro hoplimit? boolean | +--ro protocol? boolean | +--ro destination-prefix? boolean | +--ro source-prefix? boolean | +--ro flow-label? boolean | +--ro fragment? boolean +--ro tcp | +--ro sequence-number? boolean | +--ro acknowledgement-number? boolean | +--ro data-offset? boolean | +--ro reserved? boolean | +--ro flags? boolean | +--ro window-size? boolean | +--ro urgent-pointer? boolean | +--ro options? boolean | +--ro flags-bitmask? boolean | +--ro source-port? boolean | +--ro destination-port? boolean | +--ro port-range? boolean +--ro udp | +--ro length? boolean | +--ro source-port? boolean | +--ro destination-port? boolean | +--ro port-range? boolean +--ro icmp +--ro type? boolean +--ro code? boolean +--ro rest-of-header? boolean
YANG Module This module uses the common YANG types defined in and types defined in . module ietf-dots-data-channel { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-dots-data-channel"; prefix data-channel; import ietf-inet-types { prefix inet; reference "Section 4 of RFC 6991"; } import ietf-access-control-list { prefix ietf-acl; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } import ietf-packet-fields { prefix packet-fields; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } organization "IETF DDoS Open Threat Signaling (DOTS) Working Group"; contact "WG Web: <https://datatracker.ietf.org/wg/dots/> WG List: <mailto:dots@ietf.org> Editor: Mohamed Boucadair <mailto:mohamed.boucadair@orange.com> Editor: Konda, Tirumaleswar Reddy.K <mailto:TirumaleswarReddy_Konda@McAfee.com> Author: Jon Shallow <mailto:jon.shallow@nccgroup.com> Author: Kaname Nishizuka <mailto:kaname@nttv6.jp> Author: Liang Xia <mailto:frank.xialiang@huawei.com> Author: Prashanth Patil <mailto:praspati@cisco.com> Author: Andrew Mortensen <mailto:amortensen@arbor.net> Author: Nik Teague <mailto:nteague@ironmountain.co.uk>"; description "This module contains YANG definition for configuring aliases for resources and filtering rules using DOTS data channel. 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 Simplified 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 8783; see the RFC itself for full legal notices."; revision 2020-05-28 { description "Initial revision."; reference "RFC 8783: Distributed Denial-of-Service Open Threat Signaling (DOTS) Data Channel Specification"; } typedef activation-type { type enumeration { enum activate-when-mitigating { value 1; description "The Access Control List (ACL) is installed only when a mitigation is active for the DOTS client."; } enum immediate { value 2; description "The ACL is immediately activated."; } enum deactivate { value 3; description "The ACL is maintained by the DOTS server, but it is deactivated."; } } description "Indicates the activation type of an ACL."; } 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 3; 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."; } grouping tcp-flags { leaf operator { type operator; default "match"; description "Specifies how to interpret the TCP flags."; } leaf bitmask { type uint16; mandatory true; description "The bitmask matches the last 4 bits of byte 12 and byte 13 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."; } description "Operations on TCP flags."; } 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."; } grouping target { description "Specifies the targets of the mitigation request."; leaf-list target-prefix { type inet:ip-prefix; description "IPv4 or IPv6 prefix identifying the target."; } list target-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 target-protocol { type uint8; description "Identifies the target protocol number. Values are taken from the IANA protocol registry: https://www.iana.org/assignments/protocol-numbers/ For example, 6 for TCP or 17 for UDP."; } leaf-list target-fqdn { type inet:domain-name; description "FQDN identifying the target."; } leaf-list target-uri { type inet:uri; description "URI identifying the target."; } } grouping fragment-fields { leaf operator { type operator; default "match"; description "Specifies how to interpret the fragment type."; } leaf type { type fragment-type; mandatory true; description "Indicates what fragment type to look for."; } description "Operations on fragment types."; } grouping aliases { description "Top-level container for aliases."; list alias { key "name"; description "List of aliases."; leaf name { type string; description "The name of the alias."; } uses target; leaf pending-lifetime { type int32; units "minutes"; config false; description "Indicates the pending validity lifetime of the alias entry."; } } } grouping ports { choice source-port { container source-port-range-or-operator { uses packet-fields:port-range-or-operator; description "Source port definition."; } description "Choice of specifying the source port or referring to a group of source port numbers."; } choice destination-port { container destination-port-range-or-operator { uses packet-fields:port-range-or-operator; description "Destination port definition."; } description "Choice of specifying a destination port or referring to a group of destination port numbers."; } description "Choice of specifying a source or destination port numbers."; } grouping access-lists { description "Specifies the ordered set of Access Control Lists."; list acl { key "name"; ordered-by user; description "An ACL is an ordered list of Access Control Entries (ACE). Each ACE has a list of match criteria and a list of actions."; leaf name { type string { length "1..64"; } description "The name of the access list."; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } leaf type { type ietf-acl:acl-type; description "Type of access control list. Indicates the primary intended type of match criteria (e.g., IPv4, IPv6) used in the list instance."; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } leaf activation-type { type activation-type; default "activate-when-mitigating"; description "Indicates the activation type of an ACL. An ACL can be deactivated, installed immediately, or installed when a mitigation is active."; } leaf pending-lifetime { type int32; units "minutes"; config false; description "Indicates the pending validity lifetime of the ACL entry."; } container aces { description "The Access Control Entries container contains a list of ACEs."; list ace { key "name"; ordered-by user; description "List of access list entries."; leaf name { type string { length "1..64"; } description "A unique name identifying this ACE."; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } container matches { description "The rules in this set determine what fields will be matched upon before any action is taken on them. If no matches are defined in a particular container, then any packet will match that container. If no matches are specified at all in an ACE, then any packet will match the ACE."; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; choice l3 { container ipv4 { when "derived-from(../../../../type, " + "'ietf-acl:ipv4-acl-type')"; uses packet-fields:acl-ip-header-fields; uses packet-fields:acl-ipv4-header-fields; container fragment { description "Indicates how to handle IPv4 fragments."; uses fragment-fields; } description "Rule set that matches IPv4 header."; } container ipv6 { when "derived-from(../../../../type, " + "'ietf-acl:ipv6-acl-type')"; uses packet-fields:acl-ip-header-fields; uses packet-fields:acl-ipv6-header-fields; container fragment { description "Indicates how to handle IPv6 fragments."; uses fragment-fields; } description "Rule set that matches IPv6 header."; } description "Either IPv4 or IPv6."; } choice l4 { container tcp { uses packet-fields:acl-tcp-header-fields; container flags-bitmask { description "Indicates how to handle TCP flags."; uses tcp-flags; } uses ports; description "Rule set that matches TCP header."; } container udp { uses packet-fields:acl-udp-header-fields; uses ports; description "Rule set that matches UDP header."; } container icmp { uses packet-fields:acl-icmp-header-fields; description "Rule set that matches ICMP/ICMPv6 header."; } description "Can be TCP, UDP, or ICMP/ICMPv6"; } } container actions { description "Definitions of action for this ACE."; leaf forwarding { type identityref { base ietf-acl:forwarding-action; } mandatory true; description "Specifies the forwarding action per ACE."; reference "RFC 8519: YANG Data Model for Network Access Control Lists (ACLs)"; } leaf rate-limit { when "../forwarding = 'ietf-acl:accept'" { description "Rate-limit is valid only when accept action is used."; } type decimal64 { fraction-digits 2; } units "bytes per second"; description "Specifies how to rate-limit the traffic."; } } container statistics { config false; description "Aggregate statistics."; uses ietf-acl:acl-counters; } } } } } container dots-data { description "Main container for DOTS data channel."; list dots-client { key "cuid"; description "List of DOTS clients."; leaf cuid { type string; description "A unique identifier that is generated by a DOTS client to prevent request collisions."; reference "RFC 8782: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel Specification"; } leaf cdid { type string; description "A client domain identifier conveyed by a server-domain DOTS gateway to a remote DOTS server."; reference "RFC 8782: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel Specification"; } container aliases { description "Set of aliases that are bound to a DOTS client."; uses aliases; } container acls { description "Access lists that are bound to a DOTS client."; uses access-lists; } } container capabilities { config false; description "Match capabilities"; leaf-list address-family { type enumeration { enum ipv4 { description "IPv4 is supported."; } enum ipv6 { description "IPv6 is supported."; } } description "Indicates the IP address families supported by the DOTS server."; } leaf-list forwarding-actions { type identityref { base ietf-acl:forwarding-action; } description "Supported forwarding action(s)."; } leaf rate-limit { type boolean; description "Support of rate-limit action."; } leaf-list transport-protocols { type uint8; description "Upper-layer protocol associated with a filtering rule. Values are taken from the IANA protocol registry: https://www.iana.org/assignments/protocol-numbers/ For example, this field contains 1 for ICMP, 6 for TCP 17 for UDP, or 58 for ICMPv6."; } container ipv4 { description "Indicates IPv4 header fields that are supported to enforce ACLs."; leaf dscp { type boolean; description "Support of filtering based on Differentiated Services Code Point (DSCP)."; } leaf ecn { type boolean; description "Support of filtering based on Explicit Congestion Notification (ECN)."; } leaf length { type boolean; description "Support of filtering based on the Total Length."; } leaf ttl { type boolean; description "Support of filtering based on the Time to Live (TTL)."; } leaf protocol { type boolean; description "Support of filtering based on protocol field."; } leaf ihl { type boolean; description "Support of filtering based on the Internet Header Length (IHL)."; } leaf flags { type boolean; description "Support of filtering based on the 'flags'."; } leaf offset { type boolean; description "Support of filtering based on the 'offset'."; } leaf identification { type boolean; description "Support of filtering based on the 'identification'."; } leaf source-prefix { type boolean; description "Support of filtering based on the source prefix."; } leaf destination-prefix { type boolean; description "Support of filtering based on the destination prefix."; } leaf fragment { type boolean; description "Indicates the capability of a DOTS server to enforce filters on IPv4 fragments. That is, the match functionality based on the Layer 3 'fragment' clause is supported."; } } container ipv6 { description "Indicates IPv6 header fields that are supported to enforce ACLs."; leaf dscp { type boolean; description "Support of filtering based on DSCP."; } leaf ecn { type boolean; description "Support of filtering based on ECN."; } leaf length { type boolean; description "Support of filtering based on the Payload Length."; } leaf hoplimit { type boolean; description "Support of filtering based on the Hop Limit."; } leaf protocol { type boolean; description "Support of filtering based on the Next Header field."; } leaf destination-prefix { type boolean; description "Support of filtering based on the destination prefix."; } leaf source-prefix { type boolean; description "Support of filtering based on the source prefix."; } leaf flow-label { type boolean; description "Support of filtering based on the Flow Label."; } leaf fragment { type boolean; description "Indicates the capability of a DOTS server to enforce filters on IPv6 fragments."; } } container tcp { description "Set of TCP fields that are supported by the DOTS server to enforce filters."; leaf sequence-number { type boolean; description "Support of filtering based on the TCP sequence number."; } leaf acknowledgement-number { type boolean; description "Support of filtering based on the TCP acknowledgement number."; } leaf data-offset { type boolean; description "Support of filtering based on the TCP data-offset."; } leaf reserved { type boolean; description "Support of filtering based on the TCP reserved field."; } leaf flags { type boolean; description "Support of filtering, as defined in RFC 8519, based on the TCP flags."; } leaf window-size { type boolean; description "Support of filtering based on the TCP window size."; } leaf urgent-pointer { type boolean; description "Support of filtering based on the TCP urgent pointer."; } leaf options { type boolean; description "Support of filtering based on the TCP options."; } leaf flags-bitmask { type boolean; description "Support of filtering based on the TCP flags bitmask."; } leaf source-port { type boolean; description "Support of filtering based on the source port number."; } leaf destination-port { type boolean; description "Support of filtering based on the destination port number."; } leaf port-range { type boolean; description "Support of filtering based on a port range. This includes filtering based on a source port range, destination port range, or both. All operators (i.e, less than or equal to, greater than or equal to, equal to, and not equal to) are supported. In particular, this means that the implementation supports filtering based on source-port-range-or-operator and destination-port-range-or-operator."; } } container udp { description "Set of UDP fields that are supported by the DOTS server to enforce filters."; leaf length { type boolean; description "Support of filtering based on the UDP length."; } leaf source-port { type boolean; description "Support of filtering based on the source port number."; } leaf destination-port { type boolean; description "Support of filtering based on the destination port number."; } leaf port-range { type boolean; description "Support of filtering based on a port range. This includes filtering based on a source port range, destination port range, or both. All operators (i.e, less than or equal, greater than or equal, equal to, and not equal to) are supported. In particular, this means that the implementation supports filtering based on source-port-range-or-operator and destination-port-range-or-operator."; } } container icmp { description "Set of ICMP/ICMPv6 fields that are supported by the DOTS server to enforce filters."; leaf type { type boolean; description "Support of filtering based on the ICMP/ICMPv6 type."; } leaf code { type boolean; description "Support of filtering based on the ICMP/ICMPv6 code."; } leaf rest-of-header { type boolean; description "Support of filtering based on the ICMP four-byte field / the ICMPv6 message body."; } } } } }
Managing DOTS Clients
Registering DOTS Clients In order to make use of the DOTS data channel, a DOTS client MUST register with its DOTS server(s) by creating a DOTS client ('dots-client') resource. To that aim, DOTS clients SHOULD send a POST request (shown in ).
POST to Register Schema POST /restconf/data/ietf-dots-data-channel:dots-data HTTP/1.1 Host: {host}:{port} Content-Type: application/yang-data+json { "ietf-dots-data-channel:dots-client": [ { "cuid": "string" } ] }
The 'cuid' (client unique identifier) parameter is described below:
cuid:
A globally unique identifier that is meant to prevent collisions among DOTS clients. This attribute has the same meaning, syntax, and processing rules as the 'cuid' attribute defined in . DOTS clients MUST use the same 'cuid' for both signal and data channels. This is a mandatory attribute.
In deployments where server-domain DOTS gateways are enabled, identity information about the origin source client domain SHOULD be supplied to the DOTS server. That information is meant to assist the DOTS server to enforce some policies. These policies can be enforced per client, per client domain, or both. shows a schema of a register request relayed by a server-domain DOTS gateway.
POST to Register Schema (via a Server-Domain DOTS Gateway) POST /restconf/data/ietf-dots-data-channel:dots-data HTTP/1.1 Host: {host}:{port} Content-Type: application/yang-data+json { "ietf-dots-data-channel:dots-client": [ { "cuid": "string", "cdid": "string" } ] }
A server-domain DOTS gateway SHOULD add the following attribute:
cdid:
This attribute has the same meaning, syntax, and processing rules as the 'cdid' attribute defined in . In deployments where server-domain DOTS gateways are enabled, 'cdid' does not need to be inserted when relaying DOTS methods to manage aliases () or filtering rules (). DOTS servers are responsible for maintaining the association between 'cdid' and 'cuid' for policy enforcement purposes. This is an optional attribute.
An example request to create a 'dots-client' resource is depicted in . This request is relayed by a server-domain DOTS gateway as hinted by the presence of the 'cdid' attribute.
POST to Register (DOTS gateway) POST /restconf/data/ietf-dots-data-channel:dots-data HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:dots-client": [ { "cuid": "dz6pHjaADkaFTbjr0JGBpw", "cdid": "7eeaf349529eb55ed50113" } ] }
As a reminder, DOTS gateways may rewrite the 'cuid' used by peer DOTS clients (). DOTS servers can identify the DOTS client domain using the 'cdid' parameter or using the client's DNS name specified in the Subject Alternative Name extension's dNSName type in the client certificate . DOTS servers MUST limit the number of 'dots-client' resources to be created by the same DOTS client to 1 per request. Requests with multiple 'dots-client' resources MUST be rejected by DOTS servers. To that aim, the DOTS server MUST rely on the same procedure to unambiguously identify a DOTS client as discussed in . The DOTS server indicates the result of processing the POST request using status-line codes. Status codes in the "2xx" range are success, "4xx" codes are some sort of invalid requests and "5xx" codes are returned if the DOTS server has erred or is incapable of accepting the creation of the 'dots-client' resource. In particular,
  • "201 Created" status-line is returned in the response if the DOTS server has accepted the request.
  • "400 Bad Request" status-line is returned by the DOTS server if the request does not include a 'cuid' parameter. The error-tag "missing-attribute" is used in this case.
  • "409 Conflict" status-line is returned to the requesting DOTS client if the data resource already exists. The error-tag "resource-denied" is used in this case.
Once a DOTS client registers itself with a DOTS server, it can create/delete/retrieve aliases () and filtering rules (). A DOTS client MAY use the PUT request () to register a DOTS client within the DOTS server. An example is shown in .
PUT to Register PUT /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:dots-client": [ { "cuid": "dz6pHjaADkaFTbjr0JGBpw" } ] }
The DOTS gateway that inserted a 'cdid' in a PUT request MUST strip the 'cdid' parameter in the corresponding response before forwarding the response to the DOTS client.
De-registering DOTS Clients A DOTS client de-registers from its DOTS server(s) by deleting the 'cuid' resource(s). Resources bound to this DOTS client will be deleted by the DOTS server. An example of a de-register request is shown in .
De-register a DOTS Client DELETE /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com
Managing DOTS Aliases The following subsections define the means for a DOTS client to create aliases (), to retrieve one or a list of aliases (), and to delete an alias ().
Creating Aliases A POST or PUT request is used by a DOTS client to create aliases for resources for which a mitigation may be requested. Such aliases may be used in subsequent DOTS signal channel exchanges to refer more efficiently to the resources under attack. DOTS clients within the same domain can create different aliases for the same resource. The structure of POST requests used to create aliases is shown in .
POST to Create Aliases (Request Schema) POST /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=cuid HTTP/1.1 Host: {host}:{port} Content-Type: application/yang-data+json { "ietf-dots-data-channel:aliases": { "alias": [ { "name": "string", "target-prefix": [ "string" ], "target-port-range": [ { "lower-port": integer, "upper-port": integer } ], "target-protocol": [ integer ], "target-fqdn": [ "string" ], "target-uri": [ "string" ] } ] } }
The parameters are described below:
name:
Name of the alias. This is a mandatory attribute.
target-prefix:
Prefixes are separated by commas. Prefixes are represented using Classless Inter-domain Routing (CIDR) notation . As a reminder, the prefix length must be less than or equal to 32 for IPv4 or 128 for IPv6. The prefix list MUST NOT include broadcast, loopback, or multicast addresses. These addresses are considered as invalid values. In addition, the DOTS server MUST validate that these prefixes are within the scope of the DOTS client domain. Other validation checks may be supported by DOTS servers. This is an optional attribute.
target-port-range:
A range of port numbers. The port range is defined by two bounds, a lower port number ('lower-port') and an upper port number ('upper-port'). The range is considered to include both the lower and upper bounds. When only 'lower-port' is present, it represents a single port number. For TCP, UDP, Stream Control Transmission Protocol (SCTP) , or Datagram Congestion Control Protocol (DCCP) , the range of port numbers can be, for example, 1024-65535. This is an optional attribute.
target-protocol:
A list of protocols. Values are taken from the IANA protocol registry . If 'target-protocol' is not specified, then the request applies to any protocol. This is an optional attribute.
target-fqdn:
A list of Fully Qualified Domain Names (FQDNs) identifying resources under attack . How a name is passed to an underlying name resolution library is implementation and deployment specific. Nevertheless, once the name is resolved into one or multiple IP addresses, DOTS servers MUST apply the same validation checks as those for 'target-prefix'. The use of FQDNs may be suboptimal because it does not guarantee that the DOTS server will resolve a name to the same IP addresses that the DOTS client does. This is an optional attribute.
target-uri:
A list of Uniform Resource Identifiers (URIs) . The same validation checks used for 'target-fqdn' MUST be followed by DOTS servers to validate a target URI. This is an optional attribute.
In POST or PUT requests, at least one of the 'target-prefix', 'target-fqdn', or 'target-uri' attributes MUST be present. DOTS agents can safely ignore vendor-specific parameters they don't understand. If more than one 'target-*' scope types (e.g., 'target-prefix' and 'target-fqdn' or 'target-fqdn' and 'target-uri') are included in a POST or PUT request, the DOTS server binds all resulting IP addresses/prefixes to the same resource. shows a POST request to create an alias called "https1" for HTTPS servers with IP addresses 2001:db8:6401::1 and 2001:db8:6401::2 listening on TCP port number 443.
Example of a POST to Create an Alias POST /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:aliases": { "alias": [ { "name": "https1", "target-protocol": [ 6 ], "target-prefix": [ "2001:db8:6401::1/128", "2001:db8:6401::2/128" ], "target-port-range": [ { "lower-port": 443 } ] } ] } }
A "201 Created" status-line MUST be returned in the response if the DOTS server has accepted the alias. A "409 Conflict" status-line MUST be returned to the requesting DOTS client, if the request is conflicting with an existing alias name. The error-tag "resource-denied" is used in this case. If the request is missing a mandatory attribute or it contains an invalid or unknown parameter, a "400 Bad Request" status-line MUST be returned by the DOTS server. The error-tag is set to "missing-attribute", "invalid-value", or "unknown-element" as a function of the encountered error. If the request is received via a server-domain DOTS gateway, but the DOTS server does not maintain a 'cdid' for this 'cuid' while a 'cdid' is expected to be supplied, the DOTS server MUST reply with a "403 Forbidden" status-line and the error-tag "access-denied". Upon receipt of this message, the DOTS client MUST register (). A DOTS client uses the PUT request to modify the aliases in the DOTS server. In particular, a DOTS client MUST update its alias entries upon change of the prefix indicated in the 'target-prefix'. A DOTS server MUST maintain an alias for at least 10080 minutes (1 week). If no refresh request is seen from the DOTS client, the DOTS server removes expired entries.
Retrieving Installed Aliases A GET request is used to retrieve one or all installed aliases by a DOTS client from a DOTS server (). If no 'name' is included in the request, this indicates that the request is about retrieving all aliases instantiated by the DOTS client. shows an example to retrieve all the aliases that were instantiated by the requesting DOTS client. The "content" query parameter and its permitted values are defined in .
GET to Retrieve All Installed Aliases GET /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw\ /aliases?content=all HTTP/1.1 Host: example.com Accept: application/yang-data+json
shows an example of the response message body that includes all the aliases that are maintained by the DOTS server for the DOTS client identified by the 'cuid' parameter.
An Example of a Response Body Listing All Installed Aliases { "ietf-dots-data-channel:aliases": { "alias": [ { "name": "Server1", "target-protocol": [ 6 ], "target-prefix": [ "2001:db8:6401::1/128", "2001:db8:6401::2/128" ], "target-port-range": [ { "lower-port": 443 } ], "pending-lifetime": 3596 }, { "name": "Server2", "target-protocol": [ 6 ], "target-prefix": [ "2001:db8:6401::10/128", "2001:db8:6401::20/128" ], "target-port-range": [ { "lower-port": 80 } ], "pending-lifetime": 9869 } ] } }
shows an example of a GET request to retrieve the alias "Server2" that was instantiated by the DOTS client.
GET to Retrieve an Alias GET /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw\ /aliases/alias=Server2?content=all HTTP/1.1 Host: example.com Accept: application/yang-data+json
If an alias name ('name') is included in the request, but the DOTS server does not find that alias name for this DOTS client in its configuration data, it MUST respond with a "404 Not Found" status-line.
Deleting Aliases A DELETE request is used to delete an alias maintained by a DOTS server. If the DOTS server does not find the alias name that was conveyed in the DELETE request in its configuration data for this DOTS client, it MUST respond with a "404 Not Found" status-line. The DOTS server successfully acknowledges a DOTS client's request to remove the alias using "204 No Content" status-line in the response. shows an example of a request to delete an alias.
Delete an Alias DELETE /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw\ /aliases/alias=Server1 HTTP/1.1 Host: example.com
Managing DOTS Filtering Rules The following subsections define the means for a DOTS client to retrieve DOTS filtering capabilities (), to create filtering rules (), to retrieve active filtering rules (), and to delete a filtering rule ().
Retrieving DOTS Filtering Capabilities A DOTS client MAY send a GET request to retrieve the filtering capabilities supported by a DOTS server. shows an example of such request.
GET to Retrieve the Capabilities of a DOTS Server GET /restconf/data/ietf-dots-data-channel:dots-data\ /capabilities HTTP/1.1 Host: example.com Accept: application/yang-data+json
A DOTS client, which issued a GET request to retrieve the filtering capabilities supported by its DOTS server, SHOULD NOT request filtering actions that are not supported by that DOTS server. shows an example of a response body received from a DOTS server which supports:
  • IPv4, IPv6, TCP, UDP, ICMP, and ICMPv6 mandatory match criteria listed in .
  • 'accept', 'drop', and 'rate-limit' actions.
Reply to a GET Request with Filtering Capabilities (Message Body) { "ietf-dots-data-channel:capabilities": { "address-family": ["ipv4", "ipv6"], "forwarding-actions": ["drop", "accept"], "rate-limit": true, "transport-protocols": [1, 6, 17, 58], "ipv4": { "length": true, "protocol": true, "destination-prefix": true, "source-prefix": true, "fragment": true }, "ipv6": { "length": true, "protocol": true, "destination-prefix": true, "source-prefix": true, "fragment": true }, "tcp": { "flags-bitmask": true, "source-port": true, "destination-port": true, "port-range": true }, "udp": { "length": true, "source-port": true, "destination-port": true, "port-range": true }, "icmp": { "type": true, "code": true } } }
Installing Filtering Rules A POST or PUT request is used by a DOTS client to communicate filtering rules to a DOTS server. shows an example of a POST request to block traffic from 192.0.2.0/24 and destined to 198.51.100.0/24. Other examples are discussed in .
POST to Install Filtering Rules POST /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [ { "name": "sample-ipv4-acl", "type": "ipv4-acl-type", "activation-type": "activate-when-mitigating", "aces": { "ace": [ { "name": "rule1", "matches": { "ipv4": { "destination-ipv4-network": "198.51.100.0/24", "source-ipv4-network": "192.0.2.0/24" } }, "actions": { "forwarding": "drop" } } ] } } ] } }
The meaning of these parameters is as follows:
name:
The name of the access list. This is a mandatory attribute.
type:
Indicates the primary intended type of match criteria (e.g., IPv4, IPv6). It is set to 'ipv4-acl-type' in the example of . This is an optional attribute.
activation-type:
Indicates whether an ACL has to be activated (immediately or during mitigation time) or instantiated without being activated (deactivated). Deactivated ACLs can be activated using a variety of means, such as manual configuration on a DOTS server or by using the DOTS data channel. If this attribute is not provided, the DOTS server MUST use 'activate-when-mitigating' as the default value. When a mitigation is in progress, the DOTS server MUST only activate 'activate-when-mitigating' filters that are bound to the DOTS client that triggered the mitigation. This is an optional attribute.
matches:
Defines criteria used to identify a flow on which to apply the rule. It can be "l3" (IPv4, IPv6) or "l4" (TCP, UDP, ICMP). The detailed match parameters are specified in . In the example depicted in , an IPv4 matching criteria is used. This is an optional attribute.
destination-ipv4-network:
The destination IPv4 prefix. DOTS servers MUST validate that these prefixes are within the scope of the DOTS client domain. Other validation checks may be supported by DOTS servers. If this attribute is not provided, the DOTS server enforces the ACL on any destination IP address that belongs to the DOTS client domain. This is a mandatory attribute in requests with an 'activation-type' set to 'immediate'.
source-ipv4-network:
The source IPv4 prefix. This is an optional attribute.
actions:
Actions in the forwarding ACL category can be 'drop' or 'accept'. The 'accept' action is used to accept-list traffic. The "drop" action is used to drop-list traffic. Accepted traffic may be subject to 'rate-limit'; the allowed traffic rate is represented in bytes per second. This unit is the same as the one used for "traffic-rate" in . This is a mandatory attribute.
The DOTS server indicates the result of processing the POST request using the status-line. Concretely, a "201 Created" status-line MUST be returned in the response if the DOTS server has accepted the filtering rules. If the request is missing a mandatory attribute or contains an invalid or unknown parameter (e.g., a match field not supported by the DOTS server), a "400 Bad Request" status-line MUST be returned by the DOTS server in the response. The error-tag is set to "missing-attribute", "invalid-value", or "unknown-element" as a function of the encountered error. If the request is received via a server-domain DOTS gateway, but the DOTS server does not maintain a 'cdid' for this 'cuid' while a 'cdid' is expected to be supplied, the DOTS server MUST reply with a "403 Forbidden" status-line and the error-tag "access-denied". Upon receipt of this message, the DOTS client MUST register (). If the request is conflicting with an existing filtering installed by another DOTS client of the domain, absent any local policy, the DOTS server returns a "409 Conflict" status-line to the requesting DOTS client. The error-tag "resource-denied" is used in this case. The "insert" query parameter () MAY be used to specify how an access control entry is inserted within an ACL and how an ACL is inserted within an ACL set. The DOTS client uses the PUT request to modify its filtering rules maintained by the DOTS server. In particular, a DOTS client MUST update its filtering entries upon change of the destination prefix. How such change is detected is out of scope. A DOTS server MUST maintain a filtering rule for at least 10080 minutes (1 week). If no refresh request is seen from the DOTS client, the DOTS server removes expired entries. Typically, a refresh request is a PUT request that echoes the content of a response to a GET request with all of the read-only parameters stripped out (e.g., 'pending-lifetime').
Retrieving Installed Filtering Rules A DOTS client periodically queries its DOTS server to check the counters for installed filtering rules. A GET request is used to retrieve filtering rules from a DOTS server. In order to indicate which type of data is requested in a GET request, the DOTS client sets adequately the "content" query parameter. If the DOTS server does not find the access list name conveyed in the GET request in its configuration data for this DOTS client, it responds with a "404 Not Found" status-line. In order to illustrate the intended behavior, consider the example depicted in . In reference to this example, the DOTS client requests the creation of an immediate ACL called "test-acl-ipv6-udp".
Example of a PUT Request to Create a Filtering PUT /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=test-acl-ipv6-udp HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [ { "name": "test-acl-ipv6-udp", "type": "ipv6-acl-type", "activation-type": "immediate", "aces": { "ace": [ { "name": "my-test-ace", "matches": { "ipv6": { "destination-ipv6-network": "2001:db8:6401::2/127", "source-ipv6-network": "2001:db8:1234::/96", "protocol": 17, "flow-label": 10000 }, "udp": { "source-port-range-or-operator": { "operator": "lte", "port": 80 }, "destination-port-range-or-operator": { "operator": "neq", "port": 1010 } } }, "actions": { "forwarding": "accept" } } ] } } ] } }
The peer DOTS server follows the procedure specified in to process the request. We consider in the following that a positive response is sent back to the requesting DOTS client to confirm that the "test-acl-ipv6-udp" ACL is successfully installed by the DOTS server. The DOTS client can issue a GET request to retrieve all its filtering rules and the number of matches for the installed filtering rules as illustrated in . The "content" query parameter is set to 'all'. The message body of the response to this GET request is shown in .
Retrieve the Configuration Data and State Data for the Filtering Rules (GET Request) GET /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw\ /acls?content=all HTTP/1.1 Host: example.com Accept: application/yang-data+json
Retrieve the Configuration Data and State Data for the Filtering Rules (Response Message Body) { "ietf-dots-data-channel:acls": { "acl": [ { "name": "test-acl-ipv6-udp", "type": "ipv6-acl-type", "activation-type": "immediate", "pending-lifetime":9080, "aces": { "ace": [ { "name": "my-test-ace", "matches": { "ipv6": { "destination-ipv6-network": "2001:db8:6401::2/127", "source-ipv6-network": "2001:db8:1234::/96", "protocol": 17, "flow-label": 10000 }, "udp": { "source-port-range-or-operator": { "operator": "lte", "port": 80 }, "destination-port-range-or-operator": { "operator": "neq", "port": 1010 } } }, "actions": { "forwarding": "accept" } } ] } } ] } }
Also, a DOTS client can issue a GET request to retrieve only configuration data related to an ACL as shown in . It does so by setting the "content" query parameter to 'config'.
Retrieve the Configuration Data for a Filtering Rule (GET Request) GET /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=test-acl-ipv6-udp?content=config HTTP/1.1 Host: example.com Accept: application/yang-data+json
A response to this GET request is shown in .
Retrieve the Configuration Data for a Filtering Rule (Response Message Body) { "ietf-dots-data-channel:acls": { "acl": [ { "name": "test-acl-ipv6-udp", "type": "ipv6-acl-type", "activation-type": "immediate", "aces": { "ace": [ { "name": "my-test-ace", "matches": { "ipv6": { "destination-ipv6-network": "2001:db8:6401::2/127", "source-ipv6-network": "2001:db8:1234::/96", "protocol": 17, "flow-label": 10000 }, "udp": { "source-port-range-or-operator": { "operator": "lte", "port": 80 }, "destination-port-range-or-operator": { "operator": "neq", "port": 1010 } } }, "actions": { "forwarding": "accept" } } ] } } ] } }
A DOTS client can also issue a GET request with a "content" query parameter set to 'non-config' to exclusively retrieve non-configuration data bound to a given ACL as shown in . A response to this GET request is shown in .
Retrieve the Non-Configuration Data for a Filtering Rule (GET Request) GET /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=test-acl-ipv6-udp?content=non-config HTTP/1.1 Host: example.com Accept: application/yang-data+json
Retrieve the Non-Configuration Data for a Filtering Rule (Response Message Body) { "ietf-dots-data-channel:acls": { "acl": [ { "name": "test-acl-ipv6-udp", "pending-lifetime": 8000, "aces": { "ace": [ { "name": "my-test-ace" } ] } } ] } }
Removing Filtering Rules A DELETE request is used by a DOTS client to delete filtering rules from a DOTS server. If the DOTS server does not find the access list name carried in the DELETE request in its configuration data for this DOTS client, it MUST respond with a "404 Not Found" status-line. The DOTS server successfully acknowledges a DOTS client's request to withdraw the filtering rules using a "204 No Content" status-line, and removes the filtering rules accordingly. shows an example of a request to remove the IPv4 ACL "sample-ipv4-acl" created in .
Remove a Filtering Rule (DELETE Request) DELETE /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw/acls\ /acl=sample-ipv4-acl HTTP/1.1 Host: example.com
shows an example of a response received from the DOTS server to confirm the deletion of "sample-ipv4-acl".
Remove a Filtering Rule (Response) HTTP/1.1 204 No Content Server: Apache Date: Fri, 27 Jul 2018 10:05:15 GMT Cache-Control: no-cache Content-Type: application/yang-data+json Content-Length: 0 Connection: Keep-Alive
Operational Considerations The following operational considerations should be taken into account:
  • DOTS servers MUST NOT enable both DOTS data channel and direct configuration, to avoid race conditions and inconsistent configurations arising from simultaneous updates from multiple sources.
  • DOTS agents SHOULD enable the DOTS data channel to configure aliases and ACLs, and only use direct configuration as a stop-gap mechanism to test DOTS signal channel with aliases and ACLs. Further, direct configuration SHOULD only be used when the on-path DOTS agents are within the same domain.
  • If a DOTS server has enabled direct configuration, it can reject the DOTS data channel connection using hard ICMP error or RST (Reset) bit in the TCP header or reject the RESTCONF request using an error response containing a "503 Service Unavailable" status-line.
IANA Considerations IANA has registered the following URI in the "ns" subregistry within the "IETF XML Registry" :
ID:
yang:ietf-dots-data-channel
URI:
urn:ietf:params:xml:ns:yang:ietf-dots-data-channel
Registrant Contact:
The IESG.
XML:
N/A; the requested URI is an XML namespace.
Reference:
RFC 8783
IANA has registered the following YANG module in the "YANG Module Names" subregistry within the "YANG Parameters" registry.
Name:
ietf-dots-data-channel
Namespace:
urn:ietf:params:xml:ns:yang:ietf-dots-data-channel
Prefix:
data-channel
Reference:
RFC 8783
This module is not maintained by IANA.
Security Considerations RESTCONF security considerations are discussed in . In particular, DOTS agents MUST follow the security recommendations in Sections and of . Also, DOTS agents MUST support the mutual authentication TLS profile discussed in Sections and of . Authenticated encryption MUST be used for data confidentiality and message integrity. The interaction between the DOTS agents requires Transport Layer Security (TLS) with a cipher suite offering confidentiality protection, and the guidance given in MUST be followed to avoid attacks on TLS. The installation of drop-list or accept-list rules using RESTCONF over TLS reveals the attacker IP addresses and legitimate IP addresses only to the DOTS server trusted by the DOTS client. The secure communication channel between DOTS agents provides privacy and prevents a network eavesdropper from directly gaining access to the drop-listed and accept-listed IP addresses. An attacker may be able to inject RST packets, bogus application segments, etc., regardless of whether TLS authentication is used. Because the application data is TLS protected, this will not result in the application receiving bogus data, but it will constitute a DoS on the connection. This attack can be countered by using TCP Authentication Option (TCP-AO) . If TCP-AO is used, then any bogus packets injected by an attacker will be rejected by the TCP-AO integrity check and therefore will never reach the TLS layer. In order to prevent leaking internal information outside a client domain, client-side DOTS gateways SHOULD NOT reveal the identity of internal DOTS clients (e.g., source IP address, client's hostname) unless explicitly configured to do so. DOTS servers MUST verify that requesting DOTS clients are entitled to enforce filtering rules on a given IP prefix. That is, only filtering rules on IP resources that belong to the DOTS client domain can be authorized by a DOTS server. The exact mechanism for the DOTS servers to validate that the target prefixes are within the scope of the DOTS client domain is deployment specific. Rate-limiting DOTS requests, including those with new 'cuid' values, from the same DOTS client defends against DoS attacks that would result from varying the 'cuid' to exhaust DOTS server resources. Rate-limit policies SHOULD be enforced on DOTS gateways (if deployed) and DOTS servers. Applying resources quota per DOTS client and/or per DOTS client domain (e.g., limiting the number of aliases and filters to be installed by DOTS clients) prevents DOTS server resources from being aggressively used by some DOTS clients and therefore ensures DDoS mitigation usage fairness. Additionally, DOTS servers may limit the number of DOTS clients that can be enabled per domain. When FQDNs are used as targets, the DOTS server MUST rely upon DNS privacy enabling protocols (e.g., DNS over TLS or DNS over HTTPS (DoH) ) to prevent eavesdroppers from possibly identifying the target resources protected by the DDoS mitigation service, and means to ensure the target FQDN resolution is authentic (e.g., DNSSEC ). The presence of DOTS gateways may lead to infinite forwarding loops, which is undesirable. To prevent and detect such loops, a mechanism is defined in . The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF or RESTCONF . The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) . The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS . The Network Configuration Access Control Model (NACM) 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). 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. The DOTS data channel is responsible for exchanging configuration data that affect traffic filtering during DDoS attack mitigation, in particular. Appropriate security measures are recommended to prevent illegitimate users from invoking DOTS data channel primitives on writable data nodes. Nevertheless, an attacker who can access a DOTS client is technically capable of launching various attacks, such as:
  • Setting an arbitrarily low rate-limit, which may prevent legitimate traffic from being forwarded (rate-limit).
  • Setting an arbitrarily high rate-limit, which may lead to the forwarding of illegitimate DDoS traffic (rate-limit).
  • Communicating invalid aliases to the server (alias), which will cause the failure of associating both data and signal channels.
  • Setting invalid ACL entries, which may prevent legitimate traffic from being forwarded. Likewise, invalid ACL entries may lead to forward DDoS traffic.
This module reuses YANG structures from , and the security considerations for those nodes continue to apply for this usage.
References Normative References Key words for use in RFCs to Indicate Requirement Levels In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. The IETF XML Registry This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan This memo discusses the strategy for address assignment of the existing 32-bit IPv4 address space with a view toward conserving the address space and limiting the growth rate of global routing state. This document obsoletes the original Classless Inter-domain Routing (CIDR) spec in RFC 1519, with changes made both to clarify the concepts it introduced and, after more than twelve years, to update the Internet community on the results of deploying the technology described. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Representation and Verification of Domain-Based Application Service Identity within Internet Public Key Infrastructure Using X.509 (PKIX) Certificates in the Context of Transport Layer Security (TLS) Many application technologies enable secure communication between two entities by means of Internet Public Key Infrastructure Using X.509 (PKIX) certificates in the context of Transport Layer Security (TLS). This document specifies procedures for representing and verifying the identity of application services in such interactions. [STANDARDS-TRACK] Network Configuration Protocol (NETCONF) The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK] Using the NETCONF Protocol over Secure Shell (SSH) This document describes a method for invoking and running the Network Configuration Protocol (NETCONF) within a Secure Shell (SSH) session as an SSH subsystem. This document obsoletes RFC 4742. [STANDARDS-TRACK] Common YANG Data Types This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021. Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document provides an overview of HTTP architecture and its associated terminology, defines the "http" and "https" Uniform Resource Identifier (URI) schemes, defines the HTTP/1.1 message syntax and parsing requirements, and describes related security concerns for implementations. Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS) Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS) are widely used to protect data exchanged over application protocols such as HTTP, SMTP, IMAP, POP, SIP, and XMPP. Over the last few years, several serious attacks on TLS have emerged, including attacks on its most commonly used cipher suites and their modes of operation. This document provides recommendations for improving the security of deployed services that use TLS and DTLS. The recommendations are applicable to the majority of use cases. The YANG 1.1 Data Modeling Language YANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF). JSON Encoding of Data Modeled with YANG This document defines encoding rules for representing configuration data, state data, parameters of Remote Procedure Call (RPC) operations or actions, and notifications defined using YANG as JavaScript Object Notation (JSON) text. RESTCONF Protocol This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. The JavaScript Object Notation (JSON) Data Interchange Format JavaScript Object Notation (JSON) is a lightweight, text-based, language-independent data interchange format. It was derived from the ECMAScript Programming Language Standard. JSON defines a small set of formatting rules for the portable representation of structured data. This document removes inconsistencies with other specifications of JSON, repairs specification errors, and offers experience-based interoperability guidance. Network Configuration Access Control Model The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) or the RESTCONF protocol requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. This document defines such an access control model. This document obsoletes RFC 6536. The Transport Layer Security (TLS) Protocol Version 1.3 This document specifies version 1.3 of the Transport Layer Security (TLS) protocol. TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery. This document updates RFCs 5705 and 6066, and obsoletes RFCs 5077, 5246, and 6961. This document also specifies new requirements for TLS 1.2 implementations. YANG Data Model for Network Access Control Lists (ACLs) This document defines a data model for Access Control Lists (ACLs). An ACL is a user-ordered set of rules used to configure the forwarding behavior in a device. Each rule is used to find a match on a packet and define actions that will be performed on the packet. Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel Specification Informative References Distributed-Denial-of-Service Open Threat Signaling (DOTS) Architecture This document describes an architecture for establishing and maintaining Distributed Denial of Service (DDoS) Open Threat Signaling (DOTS) within and between domains. The document does not specify protocols or protocol extensions, instead focusing on defining architectural relationships, components and concepts used in a DOTS deployment. Work in Progress Distributed-Denial-of-Service Open Threat Signaling (DOTS) Agent Discovery It may not be possible for a network to determine the cause for an attack, but instead just realize that some resources seem to be under attack. To fill that gap, Distributed-Denial-of-Service Open Threat Signaling (DOTS) allows a network to inform a DOTS server that it is under a potential attack so that appropriate mitigation actions are undertaken. This document specifies mechanisms to configure DOTS clients with their DOTS servers. The discovery procedure also covers the DOTS Signal Channel Call Home. Work in Progress Protocol Numbers IANA RESTCONF Client and Server Models This document defines two YANG modules, one module to configure a RESTCONF client and the other module to configure a RESTCONF server. Both modules support the TLS transport protocol with both standard RESTCONF and RESTCONF Call Home connections. Editorial Note (To be removed by RFC Editor) This draft 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. No other RFC Editor instructions are specified elsewhere in this document. Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements (note: not all may be present): o "AAAA" --> the assigned RFC value for draft-ietf-netconf-crypto- types o "BBBB" --> the assigned RFC value for draft-ietf-netconf-trust- anchors o "CCCC" --> the assigned RFC value for draft-ietf-netconf-keystore o "DDDD" --> the assigned RFC value for draft-ietf-netconf-tcp- client-server o "EEEE" --> the assigned RFC value for draft-ietf-netconf-ssh- client-server o "FFFF" --> the assigned RFC value for draft-ietf-netconf-tls- client-server o "GGGG" --> the assigned RFC value for draft-ietf-netconf-http- client-server o "HHHH" --> the assigned RFC value for draft-ietf-netconf-netconf- client-server o "IIII" --> the assigned RFC value for this draft Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement: o "2020-05-20" --> the publication date of this draft The following Appendix section is to be removed prior to publication: o Appendix B. Change Log Note to Reviewers (To be removed by RFC Editor) This document presents a YANG module or modules that is/are part of a collection of drafts that work together to produce the ultimate goal of the NETCONF WG: to define configuration modules for NETCONF client and servers, and RESTCONF client and servers. The relationship between the various drafts in the collection is presented in the below diagram. crypto-types ^ ^ / \ / \ trust-anchors keystore ^ ^ ^ ^ | +---------+ | | | | | | | +------------+ | tcp-client-server | / | | ^ ^ ssh-client-server | | | | ^ tls-client-server | | | ^ ^ http-client-server | | | | | ^ | | | +-----+ +---------+ | | | | | | | | +-----------|--------|--------------+ | | | | | | | | +-----------+ | | | | | | | | | | | | | | | | | netconf-client-server restconf-client-server Full draft names and link to drafts: o draft-ietf-netconf-crypto-types (html [1]) o draft-ietf-netconf-trust-anchors (html [2]) o draft-ietf-netconf-keystore (html [3]) o draft-ietf-netconf-tcp-client-server (html [4]) o draft-ietf-netconf-ssh-client-server (html [5]) o draft-ietf-netconf-tls-client-server (html [6]) o draft-ietf-netconf-http-client-server (html [7]) o draft-ietf-netconf-netconf-client-server (html [8]) o draft-ietf-netconf-restconf-client-server (html [9]) Work in Progress Requirements for Internet Hosts - Communication Layers This RFC is an official specification for the Internet community. It incorporates by reference, amends, corrects, and supplements the primary protocol standards documents relating to hosts. [STANDARDS-TRACK] Uniform Resource Identifier (URI): Generic Syntax A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK] Resource Records for the DNS Security Extensions This document is part of a family of documents that describe the DNS Security Extensions (DNSSEC). The DNS Security Extensions are a collection of resource records and protocol modifications that provide source authentication for the DNS. This document defines the public key (DNSKEY), delegation signer (DS), resource record digital signature (RRSIG), and authenticated denial of existence (NSEC) resource records. The purpose and format of each resource record is described in detail, and an example of each resource record is given. This document obsoletes RFC 2535 and incorporates changes from all updates to RFC 2535. [STANDARDS-TRACK] Datagram Congestion Control Protocol (DCCP) The Datagram Congestion Control Protocol (DCCP) is a transport protocol that provides bidirectional unicast connections of congestion-controlled unreliable datagrams. DCCP is suitable for applications that transfer fairly large amounts of data and that can benefit from control over the tradeoff between timeliness and reliability. [STANDARDS-TRACK] Stream Control Transmission Protocol This document obsoletes RFC 2960 and RFC 3309. It describes the Stream Control Transmission Protocol (SCTP). SCTP is designed to transport Public Switched Telephone Network (PSTN) signaling messages over IP networks, but is capable of broader applications. SCTP is a reliable transport protocol operating on top of a connectionless packet network such as IP. It offers the following services to its users: -- acknowledged error-free non-duplicated transfer of user data, -- data fragmentation to conform to discovered path MTU size, -- sequenced delivery of user messages within multiple streams, with an option for order-of-arrival delivery of individual user messages, -- optional bundling of multiple user messages into a single SCTP packet, and -- network-level fault tolerance through supporting of multi-homing at either or both ends of an association. The design of SCTP includes appropriate congestion avoidance behavior and resistance to flooding and masquerade attacks. [STANDARDS-TRACK] Dissemination of Flow Specification Rules This document defines a new Border Gateway Protocol Network Layer Reachability Information (BGP NLRI) encoding format that can be used to distribute traffic flow specifications. This allows the routing system to propagate information regarding more specific components of the traffic aggregate defined by an IP destination prefix. Additionally, it defines two applications of that encoding format: one that can be used to automate inter-domain coordination of traffic filtering, such as what is required in order to mitigate (distributed) denial-of-service attacks, and a second application to provide traffic filtering in the context of a BGP/MPLS VPN service. The information is carried via the BGP, thereby reusing protocol algorithms, operational experience, and administrative processes such as inter-provider peering agreements. [STANDARDS-TRACK] The TCP Authentication Option This document specifies the TCP Authentication Option (TCP-AO), which obsoletes the TCP MD5 Signature option of RFC 2385 (TCP MD5). TCP-AO specifies the use of stronger Message Authentication Codes (MACs), protects against replays even for long-lived TCP connections, and provides more details on the association of security with TCP connections than TCP MD5. TCP-AO is compatible with either a static Master Key Tuple (MKT) configuration or an external, out-of-band MKT management mechanism; in either case, TCP-AO also protects connections when using the same MKT across repeated instances of a connection, using traffic keys derived from the MKT, and coordinates MKT changes between endpoints. The result is intended to support current infrastructure uses of TCP MD5, such as to protect long-lived connections (as used, e.g., in BGP and LDP), and to support a larger set of MACs with minimal other system and operational changes. TCP-AO uses a different option identifier than TCP MD5, even though TCP-AO and TCP MD5 are never permitted to be used simultaneously. TCP-AO supports IPv6, and is fully compatible with the proposed requirements for the replacement of TCP MD5. [STANDARDS-TRACK] Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS) Heartbeat Extension This document describes the Heartbeat Extension for the Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS) protocols. The Heartbeat Extension provides a new protocol for TLS/DTLS allowing the usage of keep-alive functionality without performing a renegotiation and a basis for path MTU (PMTU) discovery for DTLS. [STANDARDS-TRACK] Specification for DNS over Transport Layer Security (TLS) This document describes the use of Transport Layer Security (TLS) to provide privacy for DNS. Encryption provided by TLS eliminates opportunities for eavesdropping and on-path tampering with DNS queries in the network, such as discussed in RFC 7626. In addition, this document specifies two usage profiles for DNS over TLS and provides advice on performance considerations to minimize overhead from using TCP and TLS with DNS. This document focuses on securing stub-to-recursive traffic, as per the charter of the DPRIVE Working Group. It does not prevent future applications of the protocol to recursive-to-authoritative traffic. YANG Tree Diagrams This document captures the current syntax used in YANG module tree diagrams. The purpose of this document is to provide a single location for this definition. This syntax may be updated from time to time based on the evolution of the YANG language. DNS Queries over HTTPS (DoH) This document defines a protocol for sending DNS queries and getting DNS responses over HTTPS. Each DNS query-response pair is mapped into an HTTP exchange. DNS Terminology The Domain Name System (DNS) is defined in literally dozens of different RFCs. The terminology used by implementers and developers of DNS protocols, and by operators of DNS systems, has sometimes changed in the decades since the DNS was first defined. This document gives current definitions for many of the terms used in the DNS in a single document. This document obsoletes RFC 7719 and updates RFC 2308. DDoS Open Threat Signaling (DOTS) Requirements This document defines the requirements for the Distributed Denial-of- Service (DDoS) Open Threat Signaling (DOTS) protocols enabling coordinated response to DDoS attacks.
Examples: Filtering Fragments This specification strongly recommends the use of 'fragment' for handling fragments. shows the content of the POST request to be issued by a DOTS client to its DOTS server 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.
Filtering IPv4 Fragmented Packets POST /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [ { "name": "dns-fragments", "type": "ipv4-acl-type", "aces": { "ace": [ { "name": "drop-all-fragments", "matches": { "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-range-or-operator": { "operator": "eq", "port": 53 } }, "actions": { "forwarding": "accept" } } } ] } } ] } }
shows an example of a POST request issued by a DOTS client to its DOTS server 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.
Filtering IPv6 Fragmented Packets POST /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=dz6pHjaADkaFTbjr0JGBpw HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [ { "name": "dns-fragments", "type": "ipv6-acl-type", "aces": { "ace": [ { "name": "drop-all-fragments", "matches": { "ipv6": { "fragment": { "operator": "match", "type": "isf" } } }, "actions": { "forwarding": "drop" } }, { "name": "allow-dns-packets", "matches": { "ipv6": { "destination-ipv6-network": "2001:db8::/32" }, "udp": { "destination-port-range-or-operator": { "operator": "eq", "port": 53 } } }, "actions": { "forwarding": "accept" } } ] } } ] } }
Examples: Filtering TCP Messages This section provides examples to illustrate TCP-specific filtering based on the flag bits. These examples should not be interpreted as recommended filtering behaviors under specific DDoS attacks.
Discard TCP Null Attack shows an example of a DOTS request sent by a DOTS client to install immediately a filter to discard incoming TCP messages having all flags unset. The bitmask can be set to 255 to check against the (CWR, ECE, URG, ACK, PSH, RST, SYN, FIN) flags.
Example of a DOTS Request to Deny TCP Null Attack Messages PUT /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=tcp-flags-example HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [{ "name": "tcp-flags-example", "activation-type": "immediate", "aces": { "ace": [{ "name": "null-attack", "matches": { "tcp": { "flags-bitmask": { "operator": "not any", "bitmask": 4095 } } }, "actions": { "forwarding": "drop" } }] } }] } }
Rate-Limit SYN Flooding shows an ACL example to rate-limit incoming SYNs during a SYN flood attack.
Example of DOTS Request to Rate-Limit Incoming TCP SYNs PUT /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=tcp-flags-example HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [{ "name": "tcp-flags-example", "activation-type": "activate-when-mitigating", "aces": { "ace": [{ "name": "rate-limit-syn", "matches": { "tcp": { "flags-bitmask": { "operator": "match", "bitmask": 2 } } }, "actions": { "forwarding": "accept", "rate-limit": "20.00" } }] } }] } }
Rate-Limit ACK Flooding shows an ACL example to rate-limit incoming ACKs during an ACK flood attack.
Example of DOTS Request to Rate-Limit Incoming TCP ACKs PUT /restconf/data/ietf-dots-data-channel:dots-data\ /dots-client=paL8p4Zqo4SLv64TLPXrxA/acls\ /acl=tcp-flags-example HTTP/1.1 Host: example.com Content-Type: application/yang-data+json { "ietf-dots-data-channel:acls": { "acl": [{ "name": "tcp-flags-example", "type": "ipv4-acl-type", "activation-type": "activate-when-mitigating", "aces": { "ace": [{ "name": "rate-limit-ack", "matches": { "tcp": { "flags-bitmask": { "operator": "match", "bitmask": 16 } } }, "actions": { "forwarding": "accept", "rate-limit": "20.00" } }] } }] } }
Acknowledgements Thanks to , , , , , , , , , and for the discussion and comments. The authors would like to give special thanks to and for their efforts in implementing the protocol and performing interop testing at IETF Hackathons. Many thanks to for the detailed AD review. Thanks to for the guidance on RESTCONF. Thanks to , , , , and for the review.
Contributors The following people contributed substantially to the content of this document and should be considered coauthors: NTT Communications
GranPark 16F 3-4-1 Shibaura, Minato-ku Tokyo 108-8118 Japan kaname@nttv6.jp
Huawei
101 Software Avenue, Yuhuatai District Nanjing Jiangsu 210012 China frank.xialiang@huawei.com
Cisco Systems, Inc.
praspati@cisco.com
Arbor Networks, Inc.
2727 S. State Street Ann Arbor Michigan 48104 United States of America andrew@moretension.com
Iron Mountain Data Centers
United Kingdom nteague@ironmountain.co.uk
The following individuals have contributed to this document:
dwing-ietf@fuggles.com
NCC Group
jon.shallow@nccgroup.com
Authors' Addresses Orange
Rennes 35000 France mohamed.boucadair@orange.com
McAfee, Inc.
Embassy Golf Link Business Park Bangalore Karnataka 560071 India kondtir@gmail.com