DOTS | T. Reddy |
Internet-Draft | McAfee |
Intended status: Standards Track | M. Boucadair |
Expires: June 22, 2018 | Orange |
P. Patil | |
Cisco | |
A. Mortensen | |
Arbor Networks, Inc. | |
N. Teague | |
Verisign, Inc. | |
December 19, 2017 |
Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel
draft-ietf-dots-signal-channel-14
This document specifies the DOTS signal channel, a protocol for signaling the need for protection against Distributed Denial-of-Service (DDoS) attacks to a server capable of enabling network traffic mitigation on behalf of the requesting client.
A companion document defines the DOTS data channel, a separate reliable communication layer for DOTS management and configuration purposes.
Please update these statements with the RFC number to be assigned to this document:
Please update TBD statements with the port number to be assigned to DOTS Signal Channel Protocol.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 22, 2018.
Copyright (c) 2017 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include 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.
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 in this attack can be an application server, a host, a router, a firewall, or an entire network.
Network applications have finite resources like CPU cycles, the number of processes or threads they can create and use, the maximum number of simultaneous connections it can handle, the limited resources of the control plane, etc. When processing network traffic, such applications are supposed to use these resources to offer the intended task in the most efficient manner. However, a DDoS attacker may be able to prevent an application from performing its intended task by making the application exhaust its finite resources.
TCP DDoS SYN-flood, for example, is a memory-exhausting attack while ACK-flood is a CPU-exhausting attack [RFC4987]. Attacks on the link are carried out by sending enough traffic so that the link becomes congested, thereby likely causing packet loss for legitimate traffic. Stateful firewalls can also be attacked by sending traffic that causes the firewall to maintain an excessive number of states that may jeopardize the firewall's operation overall, besides like performance impacts. The firewall then runs out of memory, and can no longer instantiate the states required to process legitimate flows. Other possible DDoS attacks are discussed in [RFC4732].
In many cases, it may not be possible for network administrators to determine the cause(s) of an attack. They may instead just realize that certain resources seem to be under attack. This document defines a lightweight protocol that allows a DOTS client to request mitigation from one or more DOTS servers for protection against detected, suspected, or anticipated attacks. This protocol enables cooperation between DOTS agents to permit a highly-automated network defense that is robust, reliable, and secure.
An example of a network diagram that illustrates a deployment of DOTS agents is shown in Figure 1. In this example, a DOTS server is operating on the access network. A DOTS client is located on the LAN (Local Area Network), while a DOTS gateway is embedded in the CPE (Customer Premises Equipment).
Network Resource CPE router Access network __________ +-----------+ +--------------+ +-------------+ / \ | |___| |____| |___ | Internet | |DOTS client| | DOTS gateway | | DOTS server | | | | | | | | | | | +-----------+ +--------------+ +-------------+ \__________/
Figure 1: Sample DOTS Deployment (1)
DOTS servers can also be reachable over the Internet, as depicted in Figure 2.
Network DDoS mitigation Resource CPE router __________ service +-----------+ +-------------+ / \ +-------------+ | |___| |____| |___ | | |DOTS client| |DOTS gateway | | Internet | | DOTS server | | | | | | | | | +-----------+ +-------------+ \__________/ +-------------+
Figure 2: Sample DOTS Deployment (2)
The DOTS server may (not) be co-located with the DOTS mitigator. In typical deployments, the DOTS server belongs to the same administrative domain as the mitigator. The DOTS client can communicate directly with a DOTS server or indirectly via a DOTS gateway.
The document adheres to the DOTS architecture [I-D.ietf-dots-architecture]. The requirements for DOTS signal channel protocol are documented in [I-D.ietf-dots-requirements]. This document satisfies all the use cases discussed in [I-D.ietf-dots-use-cases].
This document focuses on the DOTS signal channel. This is a companion document of the DOTS data channel specification [I-D.ietf-dots-data-channel] that defines a configuration and a bulk data exchange mechanism supporting the DOTS signal channel.
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 [RFC2119].
(D)TLS is used for statements that apply to both Transport Layer Security [RFC5246] and Datagram Transport Layer Security [RFC6347]. Specific terms are used for any statement that applies to either protocol alone.
The reader should be familiar with the terms defined in [I-D.ietf-dots-architecture].
The meaning of the symbols in YANG tree diagrams is defined in [I-D.ietf-netmod-yang-tree-diagrams].
The DOTS signal channel is built on top of the Constrained Application Protocol (CoAP) [RFC7252], a lightweight protocol originally designed for constrained devices and networks. The many features of CoAP (expectation of packet loss, support for asynchronous non-confirmable messaging, congestion control, small message overhead limiting the need for fragmentation, use of minimal resources, and support for (D)TLS) makes it a good candidate to build the DOTS signaling mechanism from.
The DOTS signal channel is layered on existing standards (Figure 3).
+---------------------+ | DOTS Signal Channel | +---------------------+ | CoAP | +----------+----------+ | TLS | DTLS | +----------+----------+ | TCP | UDP | +----------+----------+ | IP | +---------------------+
Figure 3: Abstract Layering of DOTS signal channel over CoAP over (D)TLS
By default, a DOTS signal channel MUST run over port number TBD as defined in Section 9.1, for both UDP and TCP, unless the DOTS server has a mutual agreement with its DOTS clients to use a different port number. DOTS clients may alternatively support means to dynamically discover the ports used by their DOTS servers. In order to use a distinct port number (as opposed to TBD), DOTS clients and servers should support a configurable parameter to supply the port number to use. The rationale for not using the default port number 5684 ((D)TLS CoAP) is to allow for differentiated behaviors in environments where both a DOTS gateway and an IoT gateway (e.g., Figure 3 of [RFC7452]) are present.
The signal channel is initiated by the DOTS client (Section 4.4). Once the signal channel is established, the DOTS agents periodically send heartbeats to keep the channel active (Section 4.7). At any time, the DOTS client may send a mitigation request message to a DOTS server over the active channel. While mitigation is active because of the higher likelihood of packet loss during a DDoS attack, the DOTS server periodically sends status messages to the client, including basic mitigation feedback details. Mitigation remains active until the DOTS client explicitly terminates mitigation, or the mitigation lifetime expires.
DOTS signaling can happen with DTLS [RFC6347] over UDP and TLS [RFC5246] over TCP. Likewise, DOTS requests may be sent using IPv4 or IPv6 transfer capabilities. A Happy Eyeballs procedure for DOTS signal channel is specified in Section 4.3.
Messages exchanged between DOTS agents are serialized using Concise Binary Object Representation (CBOR) [RFC7049], CBOR is a binary encoding scheme designed for small code and message size. CBOR-encoded payloads are used to carry signal channel-specific payload messages which convey request parameters and response information such as errors. In order to allow the use of the same data models, [RFC7951] specifies the JSON encoding of YANG-modeled data. A similar effort for CBOR is defined in [I-D.ietf-core-yang-cbor]. All parameters in the payload of the DOTS signal channel are mapped to CBOR types as specified in Section 6.
From that standpoint, this document specifies a YANG data model for representing mitigation scopes and DOTS signal channel session configuration data (Section 5). Representing these data as CBOR data is assumed to follow the rules in [I-D.ietf-core-yang-cbor] or those in [RFC7951] combined with JSON/CBOR conversion rules in [RFC7049]. .
In order to prevent fragmentation, DOTS agents must follow the recommendations documented in Section 4.6 of [RFC7252]. Refer to Section 7.3 for more details.
DOTS agents MUST support GET, PUT, and DELETE CoAP methods. The payload included in CoAP responses with 2.xx and 3.xx Response Codes MUST be of content type "application/cbor" (Section 5.5.1 of [RFC7252]). CoAP responses with 4.xx and 5.xx error Response Codes MUST include a diagnostic payload (Section 5.5.2 of [RFC7252]). The Diagnostic Payload may contain additional information to aid troubleshooting.
In deployments where multiple DOTS clients are enabled in a network (owned and operated by the same entity), the DOTS server may detect conflicting mitigation requests from these clients. This document does not aim to specify a comprehensive list of conditions under which a DOTS server will characterize two mitigation requests from distinct DOTS clients as conflicting, nor recommend a DOTS server behavior for processing conflicting mitigation requests. Those considerations are implementation- and deployment-specific. Nevertheless, the document specifies the mechanisms to notify DOTS clients when conflicts occur, including the conflict cause (Section 4.4).
In deployments where one or more translators (e.g., Traditional NAT [RFC3022], CGN [RFC6888], NAT64 [RFC6146], NPTv6 [RFC6296]) are enabled between the client's network and the DOTS server, DOTS signal channel messages forwarded to a DOTS server must not include internal IP addresses/prefixes and/or port numbers; external addresses/prefixes and/or port numbers as assigned by the translator must be used instead. This document does not make any recommendation about possible translator discovery mechanisms. The following are some (non-exhaustive) deployment examples that may be considered:
This document assumes that DOTS clients are provisioned with the reachability information of their DOTS server(s) using a variety of means (e.g., local configuration, or dynamic means such as DHCP). These means are out of scope of this document.
Likewise, it is out of scope of this document to specify the behavior of a DOTS client when it sends requests (e.g., contact all servers, select one server among the list) when multiple DOTS servers are provisioned.
The DOTS server MUST support the use of the path-prefix of "/.well- known/" as defined in [RFC5785] and the registered name of "dots". Each DOTS operation is indicated by a path-suffix that indicates the intended operation. The operation path (Table 1) is appended to the path-prefix to form the URI used with a CoAP request to perform the desired DOTS operation.
Operation | Operation path | Details |
---|---|---|
Mitigation | /v1/mitigate | Section 4.4 |
Session configuration | /v1/config | Section 4.5 |
[I-D.ietf-dots-requirements] mentions that DOTS agents will have to support both connectionless and connection-oriented protocols. As such, the DOTS signal channel is designed to operate with DTLS over UDP and TLS over TCP. Further, a DOTS client may acquire a list of IPv4 and IPv6 addresses (Section 4.1), each of which can be used to contact the DOTS server using UDP and TCP. The following specifies the procedure to follow to select the address family and the transport protocol for sending DOTS signal channel messages.
Such procedure is needed to avoid experiencing long connection delays. For example, if an IPv4 path to reach a DOTS server is found, but the DOTS server's IPv6 path is not working, a dual-stack DOTS client may experience a significant connection delay compared to an IPv4-only DOTS client. The other problem is that if a middlebox between the DOTS client and DOTS server is configured to block UDP traffic, the DOTS client will fail to establish a DTLS session with the DOTS server and, as a consequence, will have to fall back to TLS over TCP, thereby incurring significant connection delays.
To overcome these connection setup problems, the DOTS client attempts to connect to its DOTS server(s) using both IPv6 and IPv4, and tries both DTLS over UDP and TLS over TCP in a manner similar to the Happy Eyeballs mechanism [RFC6555]. These connection attempts are performed by the DOTS client when it initializes. The results of the Happy Eyeballs procedure are used by the DOTS client for sending its subsequent messages to the DOTS server.
The order of preference of DOTS signal channel address family and transport protocol (most preferred first) is: UDP over IPv6, UDP over IPv4, TCP over IPv6, and finally TCP over IPv4. This order adheres to the address preference order specified in [RFC6724] and the DOTS signal channel preference which privileges the use of UDP over TCP (to avoid TCP's head of line blocking).
In reference to Figure 4, the DOTS client sends two TCP SYNs and two DTLS ClientHello messages at the same time over IPv6 and IPv4. In this example, it is assumed that the IPv6 path is broken and UDP traffic is dropped by a middlebox but has little impact to the DOTS client because there is no long delay before using IPv4 and TCP. The DOTS client repeats the mechanism to discover whether DOTS signal channel messages with DTLS over UDP becomes available from the DOTS server, so the DOTS client can migrate the DOTS signal channel from TCP to UDP. Such probing SHOULD NOT be done more frequently than every 24 hours and MUST NOT be done more frequently than every 5 minutes.
+-----------+ +-----------+ |DOTS client| |DOTS server| +-----------+ +-----------+ | | |--DTLS ClientHello, IPv6 ---->X | |--TCP SYN, IPv6-------------->X | |--DTLS ClientHello, IPv4 ---->X | |--TCP SYN, IPv4--------------------------------------->| |--DTLS ClientHello, IPv6 ---->X | |--TCP SYN, IPv6-------------->X | |<-TCP SYNACK-------------------------------------------| |--DTLS ClientHello, IPv4 ---->X | |--TCP ACK--------------------------------------------->| |<------------Establish TLS Session-------------------->| |----------------DOTS signal--------------------------->| | |
Figure 4: DOTS Happy Eyeballs
The following methods are used by a DOTS client to request, withdraw, or retrieve the status of mitigation requests:
Mitigation request and response messages are marked as Non-confirmable messages (Section 2.2 of [RFC7252]).
DOTS agents SHOULD follow the data transmission guidelines discussed in Section 3.1.3 of [RFC8085] and control transmission behavior by not sending more than one UDP datagram per RTT to the peer DOTS agent on average.
Requests marked by the DOTS client as Non-confirmable messages are sent at regular intervals until a response is received from the DOTS server. If the DOTS client cannot maintain an RTT estimate, it SHOULD NOT send more than one Non-confirmable request every 3 seconds, and SHOULD use an even less aggressive rate whenever possible (case 2 in Section 3.1.3 of [RFC8085]).
When a DOTS client requires mitigation for some reason, the DOTS client uses the CoAP PUT method to send a mitigation request to its DOTS server(s) (Figure 5, illustrated in JSON diagnostic notation).
If this DOTS client is entitled to solicit the DOTS service, the DOTS server can enable mitigation on behalf of the DOTS client by communicating the DOTS client's request to the mitigator and relaying selected mitigator feedback to the requesting DOTS client.
Header: PUT (Code=0.03) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "mitigate" Content-Type: "application/cbor" { "mitigation-scope": { "client-identifier": [ "string" ], "scope": [ { "mitigation-id": integer, "target-prefix": [ "string" ], "target-port-range": [ { "lower-port": integer, "upper-port": integer } ], "target-protocol": [ integer ], "target-fqdn": [ "string" ], "target-uri": [ "string" ], "alias-name": [ "string" ], "lifetime": integer } ] } }
Figure 5: PUT to convey DOTS mitigation requests
The parameters are described below:
Because of the complexity to handle partial failure cases, this specification does not allow for including multiple mitigation requests in the same PUT request. Concretely, a DOTS client MUST NOT include multiple 'scope' parameters in the same PUT request.
The CBOR key values for the parameters are defined in Section 6. Section 9 defines how the CBOR key values can be allocated to standard bodies and vendors.
FQDN and URI mitigation scopes may be thought of as a form of scope alias, in which the addresses to which the domain name or URI resolve represent the full scope of the mitigation.
In the PUT request at least one of the attributes 'target-prefix' or 'target-fqdn' or 'target-uri 'or 'alias-name' MUST be present. Attributes with emty values MUST NOT be present in a request.
The relative order of two mitigation requests from a DOTS client is determined by comparing their respective 'mitigation-id' values. If two mitigation requests have overlapping mitigation scopes, the mitigation request with the highest numeric 'mitigation-id' value will override the other mitigation request. Two mitigation-ids from a DOTS client are overlapping if there is a common IP address, IP prefix, FQDN, URI, or alias-name. To avoid maintaining a long list of overlapping mitigation requests from a DOTS client and avoid error-prone provisioning of mitigation requests from a DOTS client, the overlapped lower numeric 'mitigation-id' MUST be automatically deleted and no longer available at the DOTS server.
The Uri-Path option carries a major and minor version nomenclature to manage versioning and DOTS signal channel in this specification uses v1 major version.
Figure 6 shows a PUT request example to signal that ports 80, 8080, and 443 used by 2001:db8:6401::1 and 2001:db8:6401::2 servers are under attack (illustrated in JSON diagnostic notation).
Header: PUT (Code=0.03) Uri-Host: "www.example.com" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "v1" Uri-Path: "mitigate" Content-Format: "application/cbor" { "mitigation-scope": { "client-identifier": [ "dz6pHjaADkaFTbjr0JGBpw" ], "scope": [ { "mitigation-id": 12332, "target-prefix": [ "2001:db8:6401::1/128", "2001:db8:6401::2/128" ], "target-port-range": [ { "lower-port": 80 }, { "lower-port": 443 }, { "lower-port": 8080 } ], "target-protocol": [ 6 ] } ] } }
Figure 6: PUT for DOTS signal
The corresponding CBOR encoding format is shown in Figure 7.
A1 # map(1) 01 # unsigned(1) A2 # map(2) 18 20 # unsigned(32) 81 # array(1) 76 # text(22) 647A3670486A6141446B614654626A72304A47427077 # "dz6pHjaADkaFTbjr0JGBpw" 02 # unsigned(2) 81 # array(1) A4 # map(4) 03 # unsigned(3) 19 302C # unsigned(12332) 04 # unsigned(4) 82 # array(2) 74 # text(20) 323030313A6462383A363430313A3A312F313238 # "2001:db8:6401::1/128" 74 # text(20) 323030313A6462383A363430313A3A322F313238 # "2001:db8:6401::2/128" 05 # unsigned(5) 83 # array(3) A1 # map(1) 06 # unsigned(6) 18 50 # unsigned(80) A1 # map(1) 06 # unsigned(6) 19 01BB # unsigned(443) A1 # map(1) 06 # unsigned(6) 19 1F90 # unsigned(8080) 08 # unsigned(8) 81 # array(1) 06 # unsigned(6)
Figure 7: PUT for DOTS signal (CBOR)
If the DOTS client is using the certificate provisioned by the Enrollment over Secure Transport (EST) server [RFC7030] in the DOTS gateway-domain to authenticate itself to the DOTS gateway, then the 'client-identifier' value can be the output of a cryptographic hash algorithm whose input is the DER-encoded ASN.1 representation of the Subject Public Key Info (SPKI) of an X.509 certificate.
In this version of the specification, the cryptographic hash algorithm used is SHA-256 [RFC6234]. The output of the cryptographic hash algorithm is truncated to 16 bytes; truncation is done by stripping off the final 16 bytes. The truncated output is base64url encoded.
In both DOTS signal and data channel sessions, the DOTS client MUST authenticate itself to the DOTS server (Section 8). The DOTS server may use the algorithm presented in Section 7 of [RFC7589] to derive the DOTS client identity or username from the client certificate. The DOTS client identity allows the DOTS server to accept mitigation requests with scopes that the DOTS client is authorized to manage. The DOTS server couples the DOTS signal and data channel sessions using the DOTS client identity and the 'client-identifier' parameter value, so the DOTS server can validate whether the aliases conveyed in the mitigation request were indeed created by the same DOTS client using the DOTS data channel session. If the aliases were not created by the DOTS client, the DOTS server returns 4.00 (Bad Request) in the response.
The DOTS server couples the DOTS signal channel sessions using the DOTS client identity and the 'client-identifier' parameter value, and the DOTS server uses 'mitigation-id' parameter value to detect duplicate mitigation requests. If the mitigation request contains the alias-name and other parameters identifying the target resources (such as, 'target-prefix', 'target-port-range', 'target-fqdn', or 'target-uri'), then the DOTS server appends the parameter values in 'alias-name' with the corresponding parameter values in 'target-prefix', 'target-port-range', 'target-fqdn', or 'target-uri'.
The DOTS server indicates the result of processing the PUT request using CoAP response codes. CoAP 2.xx codes are success. CoAP 4.xx codes are some sort of invalid requests (client errors). COAP 5.xx codes are returned if the DOTS server has erred or is currently unavailable to provide mitigation in response to the mitigation request from the DOTS client.
Figure 8 shows an example of a PUT request that is successfully processed (i.e., CoAP 2.xx response codes).
{ "mitigation-scope": { "client-identifier": [ "string" ], "scope": [ { "mitigation-id": 12332, "lifetime": 3600 } ] } }
Figure 8: 2.xx response body
If the request is missing one or more mandatory attributes, or includes multiple 'scope' parameters, or contains invalid or unknown parameters, the DOTS server MUST reply with 4.00 (Bad Request). DOTS agents can safely ignore Vendor-Specific parameters they don't understand.
A DOTS server that receives a mitigation request with a lifetime set to '0' MUST reply with a 4.00 (Bad Request).
If the DOTS server does not find the 'mitigation-id' parameter value conveyed in the PUT request in its configuration data, it MAY accept the mitigation request by sending back a 2.01 (Created) response to the DOTS client; the DOTS server will consequently try to mitigate the attack.
If the DOTS server finds the 'mitigation-id' parameter value conveyed in the PUT request in its configuration data, it MAY update the mitigation request, and a 2.04 (Changed) response is returned to indicate a successful update of the mitigation request.
If the request is conflicting with an existing mitigation request from a different DOTS client, and the DOTS server decides to maintain the conflicting mitigation request, the DOTS server returns 4.09 (Conflict) [RFC8132] to the requesting DOTS client. The response includes enough information for a DOTS client to recognize the source of the conflict (refer to 'conflict-information' specified in Section 4.4.2).
For a mitigation request to continue beyond the initial negotiated lifetime, the DOTS client has to refresh the current mitigation request by sending a new PUT request. This PUT request MUST use the same 'mitigation-id' value, and MUST repeat all the other parameters as sent in the original mitigation request apart from a possible change to the lifetime parameter value.
The DOTS gateway, which inserted a 'client-identifier' attribute in a request, MUST strip the 'client-identifier' parameter in the corresponding response before forwarding the response to the DOTS client.
A GET request is used by a DOTS client to retrieve information (including status) of DOTS mitigations from a DOTS server.
The same considerations for manipulating 'client-identifier' parameter by a DOTS gateway specified in Section 4.4.1 MUST be followed for GET requests.
If the DOTS server does not find the 'mitigation-id' parameter value conveyed in the GET request in its configuration data for the requesting DOTS client or the one identified by 'client-identifier', it MUST respond with a 4.04 (Not Found) error response code. Likewise, the same error MUST be returned as a response to a request to retrieve all mitigation records of a given DOTS client if the DOTS server does not find any mitigation record for that DOTS client or the one identified by 'client-identifier'.
The 'c' (content) parameter and its permitted values defined in [I-D.ietf-core-comi] can be used to retrieve non-configuration data (attack mitigation status) or configuration data or both. The DOTS server may support this optional filtering capability. It can safely ignore it if not supported.
The following examples illustrate how a DOTS client retrieves active mitigation requests from a DOTS server. In particular:
These two examples assume the default of "c=a"; that is, the DOTS client asks for all data to be reported by the DOTS server.
Header: GET (Code=0.01) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "mitigate" Observe : 0 { "mitigation-scope": { "client-identifier": [ "dz6pHjaADkaFTbjr0JGBpw" ] } }
Figure 9: GET to retrieve all DOTS mitigation requests
Header: GET (Code=0.01) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "mitigate" Observe : 0 Content-Format: "application/cbor" { "mitigation-scope": { "client-identifier": [ "dz6pHjaADkaFTbjr0JGBpw" ], "scope": [ { "mitigation-id": 12332 } ] } }
Figure 10: GET to retrieve a specific DOTS mitigation request
Figure 11 shows a response example of all active mitigation requests associated with the DOTS client on the DOTS server and the mitigation status of each mitigation request.
{ "mitigation-scope": { "scope": [ { "mitigation-id": 12332, "mitigation-start": 1507818434.00, "target-protocol": [ 17 ], "lifetime": 1800, "status": 2, "bytes-dropped": 134334555, "bps-dropped": 43344, "pkts-dropped": 333334444, "pps-dropped": 432432 }, { "mitigation-id": 12333, "mitigation-start": 1507818393.00, "target-protocol": [ 6 ], "lifetime": 1800, "status": 3, "bytes-dropped": 0, "bps-dropped": 0, "pkts-dropped": 0, "pps-dropped": 0 } ] } }
Figure 11: Response body
The mitigation status parameters are described below:
Parameter value | Description |
---|---|
1 | Attack mitigation is in progress (e.g., changing the network path to re-route the inbound traffic to DOTS mitigator). |
2 | Attack is successfully mitigated (e.g., traffic is redirected to a DDOS mitigator and attack traffic is dropped). |
3 | Attack has stopped and the DOTS client can withdraw the mitigation request. |
4 | Attack has exceeded the mitigation provider capability. |
5 | DOTS client has withdrawn the mitigation request and the mitigation is active but terminating. |
6 | Attack mitigation is now terminated. |
7 | Attack mitigation is withdrawn. |
8 | Attack mitigation is rejected. |
The observe option defined in [RFC7641] extends the CoAP core protocol with a mechanism for a CoAP client to "observe" a resource on a CoAP server: The client retrieves a representation of the resource and requests this representation be updated by the server as long as the client is interested in the resource. A DOTS client conveys the observe option set to '0' in the GET request to receive unsolicited notifications of attack mitigation status from the DOTS server.
Unidirectional notifications within the bidirectional signal channel allows unsolicited message delivery, enabling asynchronous notifications between the agents. Due to the higher likelihood of packet loss during a DDoS attack, the DOTS server periodically sends attack mitigation status to the DOTS client and also notifies the DOTS client whenever the status of the attack mitigation changes. If the DOTS server cannot maintain a RTT estimate, it SHOULD NOT send more than one unsolicited notification every 3 seconds, and SHOULD use an even less aggressive rate whenever possible (case 2 in Section 3.1.3 of [RFC8085]).
When conflicting requests are detected, the DOTS server enforces the corresponding policy (e.g., accept all requests, reject all requests, accept only one request but reject all the others, ...). It is assumed that this policy is supplied by the DOTS server administrator or it is a default behavior of the DOTS server implementation. Then, the DOTS server sends notification message(s) to the DOTS client(s) at the origin of the conflict. A conflict notification message includes information about the conflict cause, scope, and the status of the mitigation request(s). For example,
Upon receipt of a conflict notification message indicating that a mitigation request is deactivated because of a conflict, a DOTS client MUST NOT resend the same mitigation request before the expiry of 'retry-timer'. It is also recommended that DOTS clients support means to alert administrators about mitigation conflicts.
A DOTS client that is no longer interested in receiving notifications from the DOTS server can simply "forget" the observation. When the DOTS server sends the next notification, the DOTS client will not recognize the token in the message and thus will return a Reset message. This causes the DOTS server to remove the associated entry. Alternatively, the DOTS client can explicitly deregister itself by issuing a GET request that has the Token field set to the token of the observation to be cancelled and includes an Observe Option with the value set to '1' (deregister).
Figure 12 shows an example of a DOTS client requesting a DOTS server to send notifications related to a given mitigation request.
DOTS Client DOTS Server | | | GET /<mitigation-id number> | | Token: 0x4a | Registration | Observe: 0 | +------------------------------>| | | | 2.05 Content | | Token: 0x4a | Notification of | Observe: 12 | the current state | status: "mitigation | | in progress" | |<------------------------------+ | 2.05 Content | | Token: 0x4a | Notification upon | Observe: 44 | a state change | status: "mitigation | | complete" | |<------------------------------+ | 2.05 Content | | Token: 0x4a | Notification upon | Observe: 60 | a state change | status: "attack stopped" | |<------------------------------+ | |
Figure 12: Notifications of attack mitigation status
The DOTS client can send the GET request at frequent intervals without the Observe option to retrieve the configuration data of the mitigation request and non-configuration data (i.e., the attack status). The frequency of polling the DOTS server to get the mitigation status should follow the transmission guidelines given in Section 3.1.3 of [RFC8085]. If the DOTS server has been able to mitigate the attack and the attack has stopped, the DOTS server indicates as such in the status, and the DOTS client recalls the mitigation request by issuing a DELETE request for the mitigation-id.
A DOTS client SHOULD react to the status of the attack as per the information sent by the DOTS server rather than acknowledging by itself, using its own means, that the attack has been mitigated. This ensures that the DOTS client does not recall a mitigation request prematurely because it is possible that the DOTS client does not sense the DDOS attack on its resources but the DOTS server could be actively mitigating the attack and the attack is not completely averted.
While DDoS mitigation is active, due to the likelihood of packet loss, a DOTS client MAY periodically transmit DOTS mitigation efficacy updates to the relevant DOTS server. A PUT request is used to convey the mitigation efficacy update to the DOTS server.
The PUT request MUST include all the parameters used in the PUT request to carry the DOTS mitigation request (Section 4.4.1) unchanged apart from the lifetime parameter value. If this is not the case, the DOTS server MUST reject the request with a 4.00 (Bad Request).
The If-Match Option (Section 5.10.8.1 of [RFC7252]) with an empty value is used to make the PUT request conditional on the current existence of the mitigation request. If UDP is used as transport, CoAP requests may arrive out-of-order. For example, the DOTS client may send a PUT request to convey an efficacy update to the DOTS server followed by a DELETE request to withdraw the mitigation request, but the DELETE request arrives at the DOTS server before the PUT request. To handle out-of-order delivery of requests, if an If-Match option is present in the PUT request and the 'mitigation-id' in the request matches a mitigation request from that DOTS client, then the request is processed. If no match is found, the PUT request is silently ignored.
An example of an efficacy update message, which includes an If-Match option with an empty value, is depicted in Figure 13.
Header: PUT (Code=0.03) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "mitigate" Content-Format: "application/cbor" If-Match: { "mitigation-scope": { "client-identifier": [ "string" ], "scope": [ { "mitigation-id": integer, "target-prefix": [ "string" ], "target-port-range": [ { "lower-port": integer, "upper-port": integer } ], "target-protocol": [ integer ], "target-fqdn": [ "string" ], "target-uri": [ "string" ], "alias-name": [ "string" ], "lifetime": integer, "attack-status": integer } ] } }
Figure 13: Efficacy Update
The 'attack-status' parameter is a mandatory attribute when performing an efficacy update. The various possible values contained in the 'attack-status' parameter are described in Table 3.
Parameter value | Description |
---|---|
1 | The DOTS client determines that it is still under attack. |
2 | The DOTS client determines that the attack is successfully mitigated (e.g., attack traffic is not seen). |
The DOTS server indicates the result of processing a PUT request using CoAP response codes. The response code 2.04 (Changed) is returned if the DOTS server has accepted the mitigation efficacy update. The error response code 5.03 (Service Unavailable) is returned if the DOTS server has erred or is incapable of performing the mitigation.
A DELETE request is used to withdraw a DOTS mitigation request from a DOTS server (Figure 14).
The same considerations for manipulating 'client-identifier' parameter by a DOTS gateway, as specified in Section 4.4.1, MUST be followed for DELETE requests.
Header: DELETE (Code=0.04) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "mitigate" Content-Format: "application/cbor" { "mitigation-scope": { "client-identifier": [ "string" ], "scope": [ { "mitigation-id": integer } ] } }
Figure 14: Withdraw DOTS signal
If the request does not include a 'mitigation-id' parameter, the DOTS server MUST reply with a 4.00 (Bad Request).
Once the request is validated, the DOTS server immediately acknowledges a DOTS client's request to withdraw the DOTS signal using 2.02 (Deleted) response code with no response payload. A 2.02 (Deleted) Response Code is returned even if the 'mitigation-id' parameter value conveyed in the DELETE request does not exist in its configuration data before the request.
If the DOTS server finds the 'mitigation-id' parameter value conveyed in the DELETE request in its configuration data for the DOTS client, then to protect against route or DNS flapping caused by a DOTS client rapidly removing a mitigation, and to dampen the effect of oscillating attacks, the DOTS server MAY allow mitigation to continue for a limited period after acknowledging a DOTS client's withdrawal of a mitigation request. During this period, the DOTS server status messages SHOULD indicate that mitigation is active but terminating (Section 4.4.2).
The initial active-but-terminating period SHOULD be sufficiently long to absorb latency incurred by route propagation. The active-but-terminating period SHOULD be set by default to 120 seconds. If the client requests mitigation again before the initial active-but-terminating period elapses, the DOTS server MAY exponentially increase the active-but- terminating period up to a maximum of 300 seconds (5 minutes).
After the active-but-terminating period elapses, the DOTS server MUST treat the mitigation as terminated, as the DOTS client is no longer responsible for the mitigation. For example, if there is a financial relationship between the DOTS client and server domains, the DOTS client stops incurring cost at this point.
A DOTS client can negotiate, configure, and retrieve the DOTS signal channel session behavior. The DOTS signal channel can be used, for example, to configure the following:
The same or distinct configuration sets may be used during attack ('attack-time-config') and peace times ('peace-time-config'). This is particularly useful for DOTS servers that might want to reduce heartbeat frequency or cease heartbeat exchanges when an active DOTS client has not requested mitigation. If distinct configuration are used, DOTS agents MUST follow the appropriate configuration set as a function of the mitigation activity (e.g., if no mitigation request is active, 'peace-time-config'-related values must be followed). Additionally, DOTS agents MUST automatically switch to the other configuration upon a change in the mitigation activity (e.g., if an attack mitigation is launched after a peacetime, the DOTS agent switches from 'peace-time-config' to 'attack-time-config'-related values).
Requests and responses are deemed reliable by marking them as Confirmable (CON) messages. DOTS signal channel session configuration requests and responses are marked as Confirmable messages. As explained in Section 2.1 of [RFC7252], a Confirmable message is retransmitted using a default timeout and exponential back-off between retransmissions, until the DOTS server sends an Acknowledgement message (ACK) with the same Message ID conveyed from the DOTS client.
Message transmission parameters are defined in Section 4.8 of [RFC7252]. The DOTS server can either piggyback the response in the acknowledgement message or, if the DOTS server cannot respond immediately to a request carried in a Confirmable message, it simply responds with an Empty Acknowledgement message so that the DOTS client can stop retransmitting the request. Empty Acknowledgement message is explained in Section 2.2 of [RFC7252]. When the response is ready, the server sends it in a new Confirmable message which in turn needs to be acknowledged by the DOTS client (see Sections 5.2.1 and 5.2.2 of [RFC7252]). Requests and responses exchanged between DOTS agents during peacetime are marked as Confirmable messages.
A GET request is used to obtain acceptable (e.g., minimum and maximum values) and current configuration parameters on the DOTS server for DOTS signal channel session configuration.
Figure 15 shows how to obtain acceptable configuration parameters for the DOTS server.
Header: GET (Code=0.01) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "config"
Figure 15: GET to retrieve configuration
The DOTS server in the 2.05 (Content) response conveys the current, minimum, and maximum attribute values acceptable by the DOTS server (Figure 16).
Content-Format: "application/cbor" { "attack-time-config": { "heartbeat-interval": { "current-value": integer, "min-value": integer, "max-value": integer }, "missing-hb-allowed": { "current-value": integer, "min-value": integer, "max-value": integer }, "max-retransmit": { "current-value": integer, "min-value": integer, "max-value": integer }, "ack-timeout": { "current-value": integer, "min-value": integer, "max-value": integer }, "ack-random-factor": { "current-value": number, "min-value": number, "max-value": number } }, "peace-time-config": { "heartbeat-interval": { "current-value": integer, "min-value": integer, "max-value": integer }, "missing-hb-allowed": { "current-value": integer, "min-value": integer, "max-value": integer }, "max-retransmit": { "current-value": integer, "min-value": integer, "max-value": integer }, "ack-timeout": { "current-value": integer, "min-value": integer, "max-value": integer }, "ack-random-factor": { "current-value": number, "min-value": number, "max-value": number } }, "trigger-mitigation": { "current-value": boolean }, "config-interval": { "current-value": integer, "min-value": integer, "max-value": integer } }
Figure 16: GET response body
Figure 17 shows an example of acceptable and current configuration parameters on a DOTS server for DOTS signal channel session configuration. The same acceptable configuration is used during attack and peace times.
Content-Format: "application/cbor" { "attack-time-config": { "heartbeat-interval": { "current-value": 30, "min-value": 15, "max-value": 240 }, "missing-hb-allowed": { "current-value": 5, "min-value": 3, "max-value": 9 }, "max-retransmit": { "current-value": 3, "min-value": 2, "max-value": 15 }, "ack-timeout": { "current-value": 2, "min-value": 1, "max-value": 30 }, "ack-random-factor": { "current-value": 1.5, "min-value": 1.1, "max-value": 4.0 } }, "peace-time-config": { "heartbeat-interval": { "current-value": 30, "min-value": 15, "max-value": 240 }, "missing-hb-allowed": { "current-value": 5, "min-value": 3, "max-value": 9 }, "max-retransmit": { "current-value": 3, "min-value": 2, "max-value": 15 }, "ack-timeout": { "current-value": 2, "min-value": 1, "max-value": 30 }, "ack-random-factor": { "current-value": 1.5, "min-value": 1.1, "max-value": 4.0 } }, "trigger-mitigation": { "current-value": true }, "config-interval": { "current-value": 1439, "min-value": 0, "max-value": 65535 } }
Figure 17: Configuration response body
A PUT request is used to convey the configuration parameters for the signal channel (e.g., heartbeat interval, maximum retransmissions). Message transmission parameters for CoAP are defined in Section 4.8 of [RFC7252]. The RECOMMENDED values of transmission parameter values are ack-timeout (2 seconds), max-retransmit (3), ack-random-factor (1.5). In addition to those parameters, the RECOMMENDED specific DOTS transmission parameter values are 'heartbeat-interval' (30 seconds) and 'missing-hb-allowed' (5).
When a confirmable "CoAP Ping" is sent, and if there is no response, the "CoAP Ping" is retransmitted max-retransmit number of times by the CoAP layer using an initial timeout set to a random duration between ack-timeout and (ack-timeout*ack-random-factor) and exponential back-off between retransmissions. By choosing the recommended transmission parameters, the "CoAP Ping" will timeout after 45 seconds. If the DOTS agent does not receive any response from the peer DOTS agent for 'missing-hb-allowed' number of consecutive "CoAP Ping" confirmable messages, it concludes that the DOTS signal channel session is disconnected. A DOTS client MUST NOT transmit a "CoAP Ping" while waiting for the previous "CoAP Ping" response from the same DOTS server.
If the DOTS agent wishes to change the default values of message transmission parameters, then it should follow the guidance given in Section 4.8.1 of [RFC7252]. The DOTS agents MUST use the negotiated values for message transmission parameters and default values for non-negotiated message transmission parameters.
The signal channel session configuration is applicable to a single DOTS signal channel session between the DOTS agents.
Header: PUT (Code=0.03) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "config" Content-Format: "application/cbor" { "signal-config": { "session-id": integer, "attack-time-config": { "heartbeat-interval": { "current-value": integer }, "missing-hb-allowed": { "current-value": integer }, "max-retransmit": { "current-value": integer }, "ack-timeout": { "current-value": integer }, "ack-random-factor": { "current-value": number } }, "peace-time-config": { "heartbeat-interval": { "current-value": integer }, "missing-hb-allowed": { "current-value": integer }, "max-retransmit": { "current-value": integer }, "ack-timeout": { "current-value": integer }, "ack-random-factor": { "current-value": number } }, "trigger-mitigation": boolean, "config-interval": integer } }
Figure 18: PUT to convey the DOTS signal channel session configuration data.
The parameters in Figure 18 are described below:
At least one of the attributes 'heartbeat-interval', 'missing-hb-allowed', 'max-retransmit', 'ack-timeout', 'ack-random-factor', and 'trigger-mitigation' MUST be present in the PUT request. The PUT request with a higher numeric 'session-id' value overrides the DOTS signal channel session configuration data installed by a PUT request with a lower numeric 'session-id' value.
Figure 19 shows a PUT request example to convey the configuration parameters for the DOTS signal channel. In this example, heartbeat mechanism is disabled during peacetime, while the heartbeat interval is set to '91' when an attack is active.
Header: PUT (Code=0.03) Uri-Host: "www.example.com" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "v1" Uri-Path: "config" Content-Format: "application/cbor" { "signal-config": { "session-id": 1234534333242, "attack-time-config": { "heartbeat-interval": { "current-value": 91 }, "missing-hb-allowed": { "current-value": 3 }, "max-retransmit": { "current-value": 7 }, "ack-timeout": { "current-value": 5 }, "ack-random-factor": { "current-value": 1.5 } }, "peace-time-config": { "heartbeat-interval": { "current-value": 0 }, "max-retransmit": { "current-value": 7 }, "ack-timeout": { "current-value": 5 }, "ack-random-factor": { "current-value": 1.5 } }, "trigger-mitigation": false } }
Figure 19: PUT to convey the configuration parameters
The DOTS server indicates the result of processing the PUT request using CoAP response codes:
A DELETE request is used to delete the installed DOTS signal channel session configuration data (Figure 20).
Header: DELETE (Code=0.04) Uri-Host: "host" Uri-Path: ".well-known" Uri-Path: "dots" Uri-Path: "version" Uri-Path: "config" Content-Format: "application/cbor"
Figure 20: DELETE configuration
The DOTS server resets the DOTS signal channel session configuration back to the default values and acknowledges a DOTS client's request to remove the DOTS signal channel session configuration using 2.02 (Deleted) response code.
Redirected DOTS signaling is discussed in detail in Section 3.2.2 of [I-D.ietf-dots-architecture].
If a DOTS server wants to redirect a DOTS client to an alternative DOTS server for a signal session, then the response code 3.00 (alternate server) will be returned in the response to the client.
The DOTS server can return the error response code 3.00 in response to a PUT request from the DOTS client or convey the error response code 3.00 in a unidirectional notification response from the DOTS server.
The DOTS server in the error response conveys the alternate DOTS server's FQDN, and the alternate DOTS server's IP address(es) and time to live values in the CBOR body (Figure 21).
{ "alt-server": "string", "alt-server-record": [ { "addr": "string", "ttl" : integer } ] }
Figure 21: Error response body
The parameters are described below:
Figure 22 shows a 3.00 response example to convey the DOTS alternate server 'alt-server.example', its IP addresses 2001:db8:6401::1 and 2001:db8:6401::2, and TTL values 3600 and 1800.
{ "alt-server": "alt-server.example", "alt-server-record": [ { "ttl" : 3600, "addr": "2001:db8:6401::1" }, { "ttl" : 1800, "addr": "2001:db8:6401::2" } ] }
Figure 22: Example of error response body
When the DOTS client receives 3.00 response, it considers the current request as failed, but SHOULD try re-sending the request to the alternate DOTS server. During a DDOS attack, the DNS server may be the target of another DDoS attack, alternate DOTS server's IP addresses conveyed in the 3.00 response help the DOTS client skip DNS lookup of the alternate DOTS server. The DOTS client can then try to establish a UDP or a TCP session with the alternate DOTS server. The DOTS client SHOULD implement a DNS64 function to handle the scenario where an IPv6-only DOTS client communicates with an IPv4-only alternate DOTS server.
To provide an indication of signal health and distinguish an 'idle' signal channel from a 'disconnected' or 'defunct' session, the DOTS agent sends a heartbeat over the signal channel to maintain its half of the channel. The DOTS agent similarly expects a heartbeat from its peer DOTS agent, and may consider a session terminated in the prolonged absence of a peer agent heartbeat.
While the communication between the DOTS agents is quiescent, the DOTS client will probe the DOTS server to ensure it has maintained cryptographic state and vice versa. Such probes can also keep firewalls and/or stateful translators bindings alive. This probing reduces the frequency of establishing a new handshake when a DOTS signal needs to be conveyed to the DOTS server.
In order to avoid complications due to the presence of some stateful translators and firewalls (e.g., discard an incoming packet because no matching state is found), DOTS servers MAY trigger their heartbeat requests immediately after receiving heartbeat probes from peer DOTS clients.
In case of a massive DDoS attack that saturates the incoming link(s) to the DOTS client, all traffic from the DOTS server to the DOTS client will likely be dropped, although the DOTS server receives heartbeat requests in addition to DOTS messages sent by the DOTS client. In this scenario, the DOTS agents MUST behave differently to handle message transmission and DOTS session liveliness during link saturation:
In DOTS over UDP, heartbeat messages MUST be exchanged between the DOTS agents using the “CoAP Ping” mechanism defined in Section 4.2 of [RFC7252]. Concretely, the DOTS agent sends an Empty Confirmable message and the peer DOTS agent will respond by sending a Reset message.
In DOTS over TCP, heartbeat messages MUST be exchanged between the DOTS agents using the Ping and Pong messages specified in Section 4.4 of [I-D.ietf-core-coap-tcp-tls]. That is, the DOTS agent sends a Ping message and the peer DOTS agent would respond by sending a single Pong message.
This document defines a YANG [RFC7950] module for mitigation scope and DOTS signal channel session configuration data.
module: ietf-dots-signal +--rw dots-signal +--rw (message-type)? +--:(mitigation-scope) | +--rw client-identifier* binary | +--rw scope* [mitigation-id] | +--rw mitigation-id int32 | +--rw target-prefix* inet:ip-prefix | +--rw target-port-range* [lower-port upper-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 | +--rw alias-name* string | +--rw lifetime? int32 | +--rw mitigation-start? int64 | +--ro status? enumeration | +--ro conflict-information | | +--ro conflict-status? enumeration | | +--ro conflict-cause? enumeration | | +--ro retry-timer? int32 | | +--ro conflict-scope | | +--ro target-prefix* inet:ip-prefix | | +--ro target-port-range* [lower-port upper-port] | | | +--ro lower-port inet:port-number | | | +--ro upper-port inet:port-number | | +--ro target-protocol* uint8 | | +--ro target-fqdn* inet:domain-name | | +--ro target-uri* inet:uri | | +--ro alias-name* string | | +--ro acl-list* [acl-name acl-type] | | +--ro acl-name -> /ietf-acl:access-lists/acl/acl-name | | +--ro acl-type -> /ietf-acl:access-lists/acl/acl-type | +--ro pkts-dropped? yang:zero-based-counter64 | +--ro bps-dropped? yang:zero-based-counter64 | +--ro bytes-dropped? yang:zero-based-counter64 | +--ro pps-dropped? yang:zero-based-counter64 +--:(configuration) +--rw session-id int32 +--rw attack-time-config | +--rw heartbeat-interval | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw missing-hb-allowed | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw max-retransmit | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw ack-timeout | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw ack-random-factor | +--rw max-value? decimal64 | +--rw min-value? decimal64 | +--rw current-value? decimal64 +--rw peace-time-config | +--rw heartbeat-interval | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw missing-hb-allowed | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw max-retransmit | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw ack-timeout | | +--rw max-value? int16 | | +--rw min-value? int16 | | +--rw current-value? int16 | +--rw ack-random-factor | +--rw max-value? decimal64 | +--rw min-value? decimal64 | +--rw current-value? decimal64 +--rw trigger-mitigation? boolean +--rw config-interval? int32
This document defines the YANG module "ietf-dots-signal" (Section 5.2), which has the following tree structure. A DOTS signal message can either be a mitigation or a configuration message.
<CODE BEGINS> file "ietf-dots-signal@2017-12-19.yang" module ietf-dots-signal { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-dots-signal"; prefix "signal"; import ietf-inet-types {prefix "inet";} import ietf-yang-types {prefix yang;} import ietf-access-control-list {prefix "ietf-acl";} organization "IETF DDoS Open Threat Signaling (DOTS) Working Group"; contact "Konda, Tirumaleswar Reddy <TirumaleswarReddy_Konda@McAfee.com> Mohamed Boucadair <mohamed.boucadair@orange.com> Prashanth Patil <praspati@cisco.com> Andrew Mortensen <amortensen@arbor.net> Nik Teague <nteague@verisign.com>"; description "This module contains YANG definition for the signaling messages exchanged between a DOTS client and a DOTS server. Copyright (c) 2017 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 XXXX; see the RFC itself for full legal notices."; revision 2017-12-19 { description "Initial revision."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } grouping target { description "Specifies the scope 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 upper-port"; description "Port range. When only lower-port is present, it represents a single port."; leaf lower-port { type inet:port-number; mandatory true; description "Lower port number."; } leaf upper-port { type inet:port-number; must ". >= ../lower-port" { error-message "The upper port number must be greater than or equal to lower port number."; } description "Upper port number."; } } leaf-list target-protocol { type uint8; description "Identifies the target protocol number. The value '0' means 'all protocols'. Values are taken from the IANA protocol registry: https://www.iana.org/assignments/protocol-numbers/ protocol-numbers.xhtml 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."; } leaf-list alias-name { type string; description "alias name"; } } grouping mitigation-scope { description "Specifies the scope of the mitigation request."; leaf-list client-identifier { type binary; description "The client identifier may be conveyed by the DOTS gateway to propagate the DOTS client identification information from the gateway's client-side to the gateway's server-side, and from the gateway's server-side to the DOTS server. It may be used by the final DOTS server for policy enforcement purposes."; } list scope { key mitigation-id; description "The scope of the request."; leaf mitigation-id { type int32; description "Mitigation request identifier. This identifier must be unique for each mitigation request bound to the DOTS client."; } uses target; leaf lifetime { type int32; units "seconds"; default 3600; description "Indicates the lifetime of the mitigation request."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf mitigation-start { type int64; units "seconds"; description "Mitigation start time is represented in seconds relative to 1970-01-01T00:00Z in UTC time."; } leaf status { type enumeration { enum "attack-mitigation-in-progress" { value 1; description "Attack mitigation is in progress (e.g., changing the network path to re-route the inbound traffic to DOTS mitigator)."; } enum "attack-successfully-mitigated" { value 2; description "Attack is successfully mitigated (e.g., traffic is redirected to a DDOS mitigator and attack traffic is dropped or blackholed)."; } enum "attack-stopped" { value 3; description "Attack has stopped and the DOTS client can withdraw the mitigation request."; } enum "attack-exceeded-capability" { value 4; description "Attack has exceeded the mitigation provider capability."; } enum "dots-client-withdrawn-mitigation" { value 5; description "DOTS client has withdrawn the mitigation request and the mitigation is active but terminating."; } enum "attack-mitigation-terminated" { value 6; description "Attack mitigation is now terminated."; } enum "attack-mitigation-withdrawn" { value 7; description "Attack mitigation is withdrawn."; } enum "attack-mitigation-rejected" { value 8; description "Attack mitigation is rejected."; } } config false; description "Indicates the status of a mitigation request. It must be included in responses only."; } container conflict-information { config false; description "Indicates that a conflict is detected. Must only be used for responses."; leaf conflict-status { type enumeration { enum "request-inactive-other-active" { value 1; description "DOTS Server has detected conflicting mitigation requests from different DOTS clients. This mitigation request is currently inactive until the conflicts are resolved. Another mitigation request is active."; } enum "request-active" { value 2; description "DOTS Server has detected conflicting mitigation requests from different DOTS clients. This mitigation request is currently active."; } enum "all-requests-inactive" { value 3; description "DOTS Server has detected conflicting mitigation requests from different DOTS clients. All conflicting mitigation requests are inactive."; } } description "Indicates the conflict status. It must be included in responses only."; } leaf conflict-cause { type enumeration { enum "overlapping-targets" { value 1; description "Overlapping targets. conflict-scope provides more details about the exact conflict."; } enum "conflict-with-whitelist" { value 2; description "Conflicts with an existing white list. This code is returned when the DDoS mitigation detects that some of the source addresses/prefixes listed in the white list ACLs are actually attacking the target."; } } description "Indicates the cause of the conflict. It must be included in responses only."; } leaf retry-timer { type int32; units "seconds"; description "The DOTS client must not re-send the same request before the expiry of this timer. It must be included in responses, only."; } container conflict-scope { description "Provides more information about the conflict scope."; uses target { when "../conflict-cause = 'overlapping-targets'"; } list acl-list { when "../../conflict-cause = 'conflict-with-whitelist'"; key "acl-name acl-type"; description "List of conflicting ACLs"; leaf acl-name { type leafref { path "/ietf-acl:access-lists/ietf-acl:acl" + "/ietf-acl:acl-name"; } description "Reference to the conflicting ACL name bound to a DOTS client."; } leaf acl-type { type leafref { path "/ietf-acl:access-lists/ietf-acl:acl" + "/ietf-acl:acl-type"; } description "Reference to the conflicting ACL type bound to a DOTS client."; } } } } leaf pkts-dropped { type yang:zero-based-counter64; config false; description "Number of dropped packets"; } leaf bps-dropped { type yang:zero-based-counter64; config false; description "The average number of dropped bytes per second for the mitigation request since the attack mitigation is triggered."; } leaf bytes-dropped { type yang:zero-based-counter64; units 'bytes'; config false; description "Counter for dropped packets; in bytes."; } leaf pps-dropped { type yang:zero-based-counter64; config false; description "The average number of dropped packets per second for the mitigation request since the attack mitigation is triggered."; } } } grouping config-parameters { description "Subset of DOTS signal channel session configuration."; container heartbeat-interval { description "DOTS agents regularly send heartbeats to each other after mutual authentication is successfully completed in order to keep the DOTS signal channel open."; leaf max-value { type int16; units "seconds"; description "Maximum acceptable value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf min-value { type int16; units "seconds"; description "Minimum acceptable value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf current-value { type int16; units "seconds"; default 30; description "Current value. '0' means that heartbeat mechanism is deactivated."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } } container missing-hb-allowed { description "Maximum number of missing heartbeats allowed."; leaf max-value { type int16; description "Maximum acceptable value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf min-value { type int16; description "Minimum acceptable value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf current-value { type int16; default 5; description "Current value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } } container max-retransmit { description "Maximum number of retransmissions of a Confirmable message."; leaf max-value { type int16; description "Maximum acceptable value."; reference "Section 4.8 of RFC 7552."; } leaf min-value { type int16; description "Minimum acceptable value."; reference "Section 4.8 of RFC 7552."; } leaf current-value { type int16; default 3; description "Current value."; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } } container ack-timeout { description "Initial retransmission timeout value."; leaf max-value { type int16; units "seconds"; description "Maximum value."; reference "Section 4.8 of RFC 7552."; } leaf min-value { type int16; units "seconds"; description "Minimum value."; reference "Section 4.8 of RFC 7552."; } leaf current-value { type int16; units "seconds"; default 2; description "Current value."; reference "Section 4.8 of RFC 7552."; } } container ack-random-factor { description "Random factor used to influence the timing of retransmissions."; leaf max-value { type decimal64 { fraction-digits 2; } description "Maximum acceptable value."; reference "Section 4.8 of RFC 7552."; } leaf min-value { type decimal64 { fraction-digits 2; } description "Minimum acceptable value."; reference "Section 4.8 of RFC 7552."; } leaf current-value { type decimal64 { fraction-digits 2; } default 1.5; description "Current value."; reference "Section 4.8 of RFC 7552."; } } } grouping signal-config { description "DOTS signal channel session configuration."; leaf session-id { type int32; mandatory true; description "An identifier for the DOTS signal channel session configuration data."; } container attack-time-config { description "Configuration paramaters to use when an attack is active."; uses config-parameters; } container peace-time-config { description "Configuration paramaters to use in peacetime."; uses config-parameters; } leaf trigger-mitigation { type boolean; default true; description "If false, then mitigation is triggered only when the DOTS server channel session is lost"; reference "RFC XXXX: Distributed Denial-of-Service Open Threat Signaling (DOTS) Signal Channel"; } leaf config-interval { type int32; units "minutes"; description "This parameter is returned by a DOTS server to a requesting DOTS client to indicate the time interval after which the DOTS client must contact the DOTS server in order to retrieve the signal channel configuration data. This mechanism allows the update of the configuration data if a change occurs. For example, the new configuration may instruct a DOTS client to cease heartbeats or reduce heartbeat frequency. '0' is used to disable this refresh mechanism."; } } container dots-signal { description "Main container for DOTS signal message. A DOTS signal message can be a mitigation message or a configuration message."; choice message-type { description "Either a mitigation or a configuration message."; case mitigation-scope { description "Mitigation scope of a mitigation message."; uses mitigation-scope; } case configuration { description "Configuration message."; uses signal-config; } } } } <CODE ENDS>
All parameters in the payload of the DOTS signal channel MUST be mapped to CBOR types as shown in Table 4 and are assigned an integer key to save space. The recipient of the payload MAY reject the information if it is not suitably mapped.
/----------------------+----------------+--------------------------\ | Parameter name | CBOR key | CBOR major type of value | +----------------------+----------------+--------------------------+ | mitigation-scope | 1 | 5 (map) | | scope | 2 | 5 (map) | | mitigation-id | 3 | 0 (unsigned) | | acl-list | 4 | 4 | | target-port-range | 5 | 4 | | lower-port | 6 | 0 | | upper-port | 7 | 0 | | target-protocol | 8 | 4 | | target-fqdn | 9 | 4 | | target-uri | 10 | 4 | | alias-name | 11 | 4 | | lifetime | 12 | 0 | | attack-status | 13 | 0 | | signal-config | 14 | 5 | | heartbeat-interval | 15 | 5 (map) | | max-retransmit | 16 | 5 (map) | | ack-timeout | 17 | 5 (map) | | ack-random-factor | 18 | 5 (map) | | min-value | 19 | 0 | | max-value | 20 | 0 | | status | 21 | 0 | | conflict-information | 22 | 5 (map) | | conflict-status | 23 | 0 | | conflict-cause | 24 | 0 | | retry-timer | 25 | 0 | | bytes-dropped | 26 | 0 | | bps-dropped | 27 | 0 | | pkts-dropped | 28 | 0 | | pps-dropped | 29 | 0 | | session-id | 30 | 0 | | trigger-mitigation | 31 | 7 (simple types) | | missing-hb-allowed | 32 | 5 (map) | | current-value | 33 | 0 | | mitigation-start | 34 | 7 (floating-point) | | target-prefix | 35 | 4 (array) | | client-identifier | 36 | 2 (byte string) | | alt-server | 37 | 2 | | alt-server-record | 38 | 4 | | addr | 39 | 2 | | ttl | 40 | 0 | | conflict-scope | 41 | 5 (map) | | acl-name | 42 | 3 | | acl-type | 43 | 3 | | config-interval | 44 | 0 | | attack-time-config | 45 | 5 (map) | | peace-time-config | 46 | 5 (map) | \----------------------+----------------+--------------------------/ Table 4: CBOR mappings used in DOTS signal channel message
This section defines the (D)TLS protocol profile of DOTS signal channel over (D)TLS and DOTS data channel over TLS.
There are known attacks on (D)TLS, such as man-in-the-middle and protocol downgrade attacks. These are general attacks on (D)TLS and, as such, they are not specific to DOTS over (D)TLS; refer to the (D)TLS RFCs for discussion of these security issues. DOTS agents MUST adhere to the (D)TLS implementation recommendations and security considerations of [RFC7525] except with respect to (D)TLS version. Since DOTS signal channel encryption relies upon (D)TLS is virtually a green-field deployment, DOTS agents MUST implement only (D)TLS 1.2 or later.
When a DOTS client is configured with a domain name of the DOTS server, and connects to its configured DOTS server, the server may present it with a PKIX certificate. In order to ensure proper authentication, a DOTS client MUST verify the entire certification path per [RFC5280]. The DOTS client additionally uses [RFC6125] validation techniques to compare the domain name with the certificate provided.
A key challenge to deploying DOTS is the provisioning of DOTS clients, including the distribution of keying material to DOTS clients to enable the required mutual authentication of DOTS agents. EST defines a method of certificate enrollment by which domains operating DOTS servers may provide DOTS clients with all the necessary cryptographic keying material, including a private key and a certificate to authenticate themselves. One deployment option is DOTS clients behave as EST clients for certificate enrollment from an EST server provisioned by the mitigation provider. This document does not specify which EST mechanism the DOTS client uses to achieve initial enrollment.
Implementations compliant with this profile MUST implement all of the following items:
Implementations compliant with this profile SHOULD implement all of the following items to reduce the delay required to deliver a DOTS signal channel message:
TLS 1.3 [I-D.ietf-tls-tls13] provides critical latency improvements for connection establishment over TLS 1.2. The DTLS 1.3 protocol [I-D.ietf-tls-dtls13] is based upon the TLS 1.3 protocol and provides equivalent security guarantees. (D)TLS 1.3 provides two basic handshake modes the DOTS signal channel can take advantage of:
DOTS Client DOTS Server ClientHello (Finished) (0-RTT DOTS signal message) (end_of_early_data) --------> ServerHello {EncryptedExtensions} {ServerConfiguration} {Certificate} {CertificateVerify} {Finished} <-------- [DOTS signal message] {Finished} --------> [DOTS signal message] <-------> [DOTS signal message]
Figure 23: TLS 1.3 handshake with 0-RTT
To avoid DOTS signal message fragmentation and the subsequent decreased probability of message delivery, DOTS agents MUST ensure that the DTLS record MUST fit within a single datagram. If the path MTU is not known to the DOTS server, an IP MTU of 1280 bytes SHOULD be assumed. The length of the URL MUST NOT exceed 256 bytes. If UDP is used to convey the DOTS signal messages then the DOTS client must consider the amount of record expansion expected by the DTLS processing when calculating the size of CoAP message that fits within the path MTU. Path MTU MUST be greater than or equal to [CoAP message size + DTLS overhead of 13 octets + authentication overhead of the negotiated DTLS cipher suite + block padding (Section 4.1.1.1 of [RFC6347]). If the request size exceeds the path MTU then the DOTS client MUST split the DOTS signal into separate messages, for example the list of addresses in the 'target-prefix' parameter could be split into multiple lists and each list conveyed in a new PUT request.
Implementation Note: DOTS choice of message size parameters works well with IPv6 and with most of today's IPv4 paths. However, with IPv4, it is harder to reliably ensure that there is no IP fragmentation. If IPv4 path MTU is unknown, implementations may want to limit themselves to more conservative IPv4 datagram sizes such as 576 bytes, as per [RFC0791]. IP packets whose size does not exceed 576 bytes should never need to be fragmented: therefore, sending a maximum of 500 bytes of DOTS signal over a UDP datagram will generally avoid IP fragmentation.
(D)TLS based upon client certificate can be used for mutual authentication between DOTS agents. If a DOTS gateway is involved, DOTS clients and DOTS gateways MUST perform mutual authentication; only authorized DOTS clients are allowed to send DOTS signals to a DOTS gateway. The DOTS gateway and the DOTS server MUST perform mutual authentication; a DOTS server only allows DOTS signal channel messages from an authorized DOTS gateway, thereby creating a two-link chain of transitive authentication between the DOTS client and the DOTS server.
+-----------------------------------------------+ | example.com domain +---------+ | | | AAA | | | +---------------+ | Server | | | | Application | +------+--+ | | | server +<-----------------+ ^ | | | (DOTS client) | | | | | +---------------+ | | | | V V | example.net domain | +-----+----+--+ | +---------------+ | +--------------+ | | | | | | | Guest +<-----x----->+ DOTS +<------>+ DOTS | | | (DOTS client)| | Gateway | | | Server | | +--------------+ | | | | | | +----+--------+ | +---------------+ | ^ | | | | | +----------------+ | | | | DDOS detector | | | | | (DOTS client) +<---------------+ | | +----------------+ | +-----------------------------------------------+
Figure 24: Example of Authentication and Authorization of DOTS Agents
Figure 24, the DOTS gateway and DOTS clients within the 'example.com' domain mutually authenticate with each other. After the DOTS gateway validates the identity of a DOTS client, it communicates with the AAA server in the 'example.com' domain to determine if the DOTS client is authorized to request DDoS mitigation. If the DOTS client is not authorized, a 4.01 (Unauthorized) is returned in the response to the DOTS client. In this example, the DOTS gateway only allows the application server and DDoS attack detector to request DDOS mitigation, but does not permit the user of type 'guest' to request DDoS mitigation.
Also, DOTS gateways and servers located in different domains MUST perform mutual authentication (e.g., using certificates). A DOTS server will only allow a DOTS gateway with a certificate for a particular domain to request mitigation for that domain. In reference to Figure 24, the DOTS server only allows the DOTS gateway to request mitigation for 'example.com' domain and not for other domains.
This specification registers a service port (Section 9.1), an URI suffix in the Well-Known URIs registry (Section 9.2), a CoAP response code (Section 9.3), a YANG module (Section 9.5). It also creates a registry for mappings to CBOR (Section 9.4).
IANA is requested to assign the port number TBD to the DOTS signal channel protocol for both UDP and TCP from the "Service Name and Transport Protocol Port Number Registry" available at https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.
The assignment of port number 4646 is strongly suggested, as 4646 is the ASCII decimal value for ".." (DOTS).
This document requests IANA to register the 'dots' well-known URI in the Well-Known URIs registry (https://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml) as defined by [RFC5785].
URI suffix: dots
Change controller: IETF
Specification document(s): This RFC
Related information: None
IANA is requested to add the following entry to the "CoAP Response Codes" sub-registry available at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#response-codes:
Code | Description | Reference |
---|---|---|
3.00 | Alternate server | [RFCXXXX] |
The document requests IANA to create a new registry, entitled "DOTS Signal Channel CBOR Mappings Registry". The structure of this registry is provided in Section 9.4.1.
The registry is initially populated with the values in Section 9.4.2.
Values from that registry MUST be assigned via Expert Review [RFC8126].
URI: urn:ietf:params:xml:ns:yang:ietf-dots-signal Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace.
name: ietf-signal namespace: urn:ietf:params:xml:ns:yang:ietf-dots-signal prefix: signal reference: RFC XXXX
This document requests IANA to register the following URI in the "IETF XML Registry" [RFC3688]: [RFC7950].
[Note to RFC Editor: Please remove this section and reference to [RFC7942] prior to publication.]
This section records the status of known implementations of the protocol defined by this specification at the time of posting this Internet-Draft, and is based upon a proposal described in [RFC7942]. The description of implementations in this section is intended to assist the IETF in its decision-making process when progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here, and which was provided by individuals. This is not intended as, and must not be construed to be, a catalog of available implementations or features. Readers are advised to note that other implementations may exist.
According to [RFC7942], "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".
Authenticated encryption MUST be used for data confidentiality and message integrity. The interaction between the DOTS agents requires Datagram Transport Layer Security (DTLS) and Transport Layer Security (TLS) with a cipher suite offering confidentiality protection and the guidance given in [RFC7525] MUST be followed to avoid attacks on (D)TLS. The (D)TLS protocol profile for DOTS signal channel is specified in Section 7.
A single DOTS signal channel between DOTS agents can be used to exchange multiple DOTS signal messages. To reduce DOTS client and DOTS server workload, DOTS clients SHOULD re-use the (D)TLS session.
If TCP is used between DOTS agents, 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-AO [RFC5925]. 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, DOTS gateways located in the client-domain SHOULD NOT reveal the identification information that pertains to internal DOTS clients (client-identifier) unless explicitly configured to do so.
Special care should be taken in order to ensure that the activation of the proposed mechanism will not impact the stability of the network (including connectivity and services delivered over that network).
The following individuals have contributed to this document:
Mike Geller Cisco Systems, Inc. 3250 Florida 33309 USA Email: mgeller@cisco.com
Robert Moskowitz HTT Consulting Oak Park, MI 42837 United States Email: rgm@htt-consult.com
Dan Wing Email: dwing-ietf@fuggles.com
Thanks to Christian Jacquenet, Roland Dobbins, Roman D. Danyliw, Michael Richardson, Ehud Doron, Kaname Nishizuka, Dave Dolson, Liang Xia, Gilbert Clark, and Nesredien Suleiman for the discussion and comments.
Special thanks to Jon Shallow for the careful reviews and inputs that enhanced this specification.