<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="4"?>
<?rfc tocindent="yes"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc compact="yes"?>
<?rfc subcompact="no"?>
<rfc category="std" docName="draft-nishizuka-dots-signal-control-filtering-00"
     ipr="trust200902">
  <front>
    <title abbrev="DOTS Signal Control Filtering">Controlling Filtering Rules
    Using DOTS Signal Channel</title>

    <author fullname="Kaname Nishizuka" initials="K." role="editor"
            surname="Nishizuka">
      <organization>NTT Communications</organization>

      <address>
        <postal>
          <street>GranPark 16F 3-4-1 Shibaura, Minato-ku</street>

          <city>Tokyo</city>

          <region></region>

          <code>108-8118</code>

          <country>Japan</country>
        </postal>

        <email>kaname@nttv6.jp</email>
      </address>
    </author>

    <author fullname="Takahiko Nagata" initials="T." surname="Nagata">
      <organization>Lepidum</organization>

      <address>
        <postal>
          <street></street>

          <city></city>

          <region></region>

          <code></code>

          <country>Japan</country>
        </postal>

        <email>nagata@lepidum.co.jp</email>
      </address>
    </author>

    <author fullname="Tirumaleswar Reddy" initials="T." role="editor"
            surname="Reddy">
      <organization abbrev="McAfee">McAfee, Inc.</organization>

      <address>
        <postal>
          <street>Embassy Golf Link Business Park</street>

          <city>Bangalore</city>

          <region>Karnataka</region>

          <code>560071</code>

          <country>India</country>
        </postal>

        <email>kondtir@gmail.com</email>
      </address>
    </author>

    <author fullname="Mohamed Boucadair" initials="M." surname="Boucadair">
      <organization>Orange</organization>

      <address>
        <postal>
          <street></street>

          <city>Rennes</city>

          <code>35000</code>

          <country>France</country>
        </postal>

        <email>mohamed.boucadair@orange.com</email>
      </address>
    </author>

    <date />

    <workgroup>DOTS</workgroup>

    <keyword>Mitigation</keyword>

    <keyword>Automation</keyword>

    <keyword>Filtering</keyword>

    <abstract>
      <t>This document specifies an extension to the DOTS signal channel to
      control the filtering rules during attack mitigation.</t>

      <t>This extension allows a DOTS client to activate or de-activate
      filtering rules during a DDoS attack. The characterization of these
      filters is supposed to be conveyed by a DOTS client during peace time by
      means of DOTS data channel.</t>
    </abstract>

    <note title="Editorial Note (To be removed by RFC Editor)">
      <t>Please update these statements within the document with the RFC
      number to be assigned to this document:<list style="symbols">
          <t>"This version of this YANG module is part of RFC XXXX;"</t>

          <t>"RFC XXXX: Controlling Filtering Rules Using DOTS Signal
          Channel";</t>

          <t>reference: RFC XXXX</t>

          <t>[RFCXXXX]</t>
        </list>Please update these statements with the RFC number to be
      assigned to the following documents:<list style="symbols">
          <t>"RFC SSSS: Distributed Denial-of-Service Open Threat Signaling
          (DOTS) Signal Channel Specification" (used to be <xref
          target="I-D.ietf-dots-signal-channel"></xref>)</t>

          <t>"RFC DDDD: Distributed Denial-of-Service Open Threat Signaling
          (DOTS) Data Channel Specification" (used to be <xref
          target="I-D.ietf-dots-data-channel"></xref>)</t>
        </list>Please update the "revision" date of the YANG module.</t>
    </note>
  </front>

  <middle>
    <section anchor="introduction" title="Introduction">
      <section anchor="problem" title="The Problem">
        <t>The DOTS data channel protocol <xref
        target="I-D.ietf-dots-data-channel"></xref> is used for bulk data
        exchange between DOTS agents to improve the coordination of all the
        parties involved in the response to the DDoS attack. Filter management
        is one of its tasks which enables a DOTS client to retrieve DOTS
        server filtering capabilities and to manage filtering rules. Filtering
        rules are used for dropping or rate-limiting unwanted traffic, and
        permitting accept-listed traffic.</t>

        <t>Unlike the signal channel, the data channel is not expected to deal
        with attack conditions. As such, an issue that might be encountered in
        some deployments is when filters installed by means of DOTS data
        channel protocol may not function as expected during DDoS attacks or
        exacerbate an ongoing DDoS attack. The DOTS data channel cannot be
        used then to change these filters, which may complicate DDoS
        mitigation operations.</t>

        <t>A typical case is a DOTS client which configures during peace time
        filtering rules using data channel to permit traffic from
        accept-listed sources, but during the volumetric DDoS attack the DDoS
        mitigator identifies the source addresses/prefixes in the
        accept-listed filtering rules are attacking the target. For example,
        an attacker can spoof the IP addresses of accept-listed sources to
        generate attack traffic or the attacker can compromise the
        accept-listed sources and program them to launch DDoS attack.</t>

        <t><xref target="I-D.ietf-dots-signal-channel"></xref> is designed so
        that the DDoS server notifies the conflict to the DOTS client
        ('conflict-cause' set to 2 (Conflicts with an existing accept list)),
        but the DOTS client may not be able to withdraw the accept-listed
        filtering rules during the attack period due to the high-volume attack
        traffic saturating the inbound link. In other words, the DOTS client
        cannot use the DOTS data channel to withdraw the accept-listed filters
        when the DDoS attack is in progress. This assumes that this DOTS
        client is the owner of the filtering rule.</t>
      </section>

      <section anchor="sol" title="The Solution">
        <t>This specification addresses the problems discussed in <xref
        target="problem"></xref> by adding the capability of managing
        filtering rules using the DOTS signal channel, which enables a DOTS
        client to request the activation or de-activation of filtering rules
        during a DDoS attack.</t>

        <t>The DOTS signal channel protocol <xref
        target="I-D.ietf-dots-signal-channel"></xref> is designed to enable a
        DOTS client to contact a DOTS server for help even under severe
        network congestion conditions. Therefore, extending the DOTS signal
        channel protocol to manage the filtering rules during a attack will
        enhance the protection capability offered by DOTS protocols.</t>

        <t><list style="empty">
            <t>Note: The experiment at the IETF103 hackathon showed that even
            when the incoming link is saturated by DDoS attack traffic, the
            DOTS client can signal mitigation requests using the DOTS signal
            channel over the saturated link.</t>
          </list></t>

        <t>Conflicts that are induced by filters installed by other DOTS
        clients of the same domain are not discussed in this
        specification.</t>
      </section>
    </section>

    <section anchor="notation" title="Notational Conventions and Terminology">
      <t>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
      <xref target="RFC2119"></xref> <xref target="RFC8174"></xref> when, and
      only when, they appear in all capitals, as shown here.</t>

      <t>The reader should be familiar with the terms defined in <xref
      target="I-D.ietf-dots-requirements"></xref>.</t>
    </section>

    <section title="Controlling Filtering Rules">
      <section title="Binding of the Data Channel and Signal Channel">
        <t>The filtering rules eventually managed using the DOTS signal
        channel must be created a priori by the same DOTS client using the
        DOTS data channel. Managing conflicts with filters installed by other
        DOTS clients of the same domain is out of scope.</t>

        <t>As discussed in Section 4.4.1 of <xref
        target="I-D.ietf-dots-signal-channel"></xref>, a DOTS client must use
        the same 'cuid' for both the signal and data channels. This
        requirement is meant to facilitate binding channels used by the same
        DOTS client.</t>

        <t>The DOTS signal and data channels from a DOTS client may or may not
        use the same DOTS server. Nevertheless, the scope of the mitigation
        request, alias, and filtering rules are not restricted to the DOTS
        server but to the DOTS server administrative domain. To that aim, DOTS
        servers within a domain are assumed to have a mechanism to coordinate
        the mitigation requests, aliases, and filtering rules to coordinate
        their decisions for better mitigation operation efficiency. The exact
        details about such mechanism is out of scope of this document.</t>

        <t>A filtering rule controlled by the DOTS signal channel is
        identified by its Access Control List (ACL) name. Note that an ACL
        name unambiguously identifies an ACL bound to a DOTS client, but the
        same name may be used by distinct DOTS clients.</t>

        <t>The activation or de-activation of an ACL by the signal channel
        overrides the 'activation-type' (defined in Section 7.2 <xref
        target="I-D.ietf-dots-data-channel"></xref>) a priori conveyed with
        the filtering rules using the DOTS data channel.</t>
      </section>

      <section title="DOTS Signal Channel Extension">
        <section anchor="filtering" title="Filtering Control">
          <t>This specification extends the mitigation request defined in
          <xref target="I-D.ietf-dots-signal-channel"></xref> to convey the
          intended control of the configured filtering rules. The DOTS client
          conveys the following parameters in the CBOR body of the mitigation
          request:<list style="hanging">
              <t hangText="acl-name:">A name of an access list defined in the
              data channel.<vspace blankLines="1" />As a reminder, an ACL is
              an ordered list of Access Control Entries (ACE). Each Access
              Control Entry has a list of match criteria and a list of
              actions. The list of configured ACLs can be retrieved using the
              DOTS data channel during peace time.<vspace blankLines="1" />
              This is an optional attribute.</t>

              <t hangText="activation-type:">Indicates the activation type of
              an ACL overriding the existing 'activation-type' installed by
              the DOTS data channel. This attribute can be set to
              'deactivate', 'immediate', or 'activate-when-mitigating' defined
              <xref target="I-D.ietf-dots-data-channel"></xref>. Note that
              'immediate' or 'activate-when-mitigating' are equivalent when a
              mitigation request is being processed by the server.<vspace
              blankLines="1" />If this attribute is not provided, the DOTS
              server MUST use 'activate-when-mitigating' as the default value.
              <vspace blankLines="1" />This is an optional attribute.</t>
            </list></t>

          <t>If the DOTS server does not find the ACL name conveyed in the
          mitigation request in its configuration data for this DOTS client,
          it MUST respond with a "4.04 (Not Found)" error response code.</t>
        </section>

        <section anchor="YANG" title="DOTS Signal Filtering Control Module ">
          <section title="Tree Structure">
            <t>This document augments the "dots-signal-channel" DOTS signal
            YANG module defined in <xref
            target="I-D.ietf-dots-signal-channel"></xref> for managing the
            filtering rules.</t>

            <t>This document defines the YANG module
            "ietf-dots-signal-control-filter", which has the following tree
            structure:<figure>
                <artwork><![CDATA[module: ietf-dots-signal-control-filter
  augment /ietf-signal:dots-signal/ietf-signal:message-type
           /ietf-signal:mitigation-scope/ietf-signal:scope:
    +--rw acl-list* [acl-name] {control-filtering}?
       +--rw acl-name          
       |    -> /ietf-data:dots-data/dots-client/acls/acl/name
       +--rw activation-type?    enumeration 
]]></artwork>
              </figure></t>
          </section>

          <section title="YANG Module">
            <t><figure>
                <artwork><![CDATA[<CODE BEGINS> file "ietf-dots-signal-control-filter@2018-11-20.yang"

module ietf-dots-signal-control-filter {
  yang-version 1.1;
  namespace 
     "urn:ietf:params:xml:ns:yang:ietf-dots-signal-control-filter";
  prefix signal-control-filter;

  import ietf-dots-signal-channel {
    prefix ietf-signal;
    reference
      "RFC SSSS: Distributed Denial-of-Service Open Threat
                 Signaling (DOTS) Signal Channel Specification";
    }
  import ietf-dots-data-channel {
    prefix ietf-data;
    reference
      "RFC DDDD: Distributed Denial-of-Service Open Threat
                 Signaling (DOTS) Data Channel Specification";
  }
    
  organization
    "IETF DDoS Open Threat Signaling (DOTS) Working Group";
  contact
    "WG Web:   <https://datatracker.ietf.org/wg/dots/>
     WG List:  <mailto:dots@ietf.org>

     Author:  Konda, Tirumaleswar Reddy
              <mailto:TirumaleswarReddy_Konda@McAfee.com>;

     Author:  Kaname Nishizuka
              <mailto:kaname@nttv6.jp>;

     Author:  Takahiko Nagata
                 <mailto:nagata@lepidum.co.jp>

     Author:  Mohamed Boucadair
              <mailto:mohamed.boucadair@orange.com>;";

     description
       "This module contains YANG definition for the signaling
        messages exchanged between a DOTS client and a DOTS server
        for the DOTS signal channel controlling the filtering rules 
        configured using the DOTS data channel.

        Copyright (c) 2018 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 2018-11-20 {
        description
          "Initial revision.";
        reference
          "RFC XXXX: Controlling Filtering Rules Using DOTS Signal
                     Channel ";
      }

      feature control-filtering {
        description
          "This feature means that DOTS signal channel is able to 
           manage the filtering rules created by the same DOTS 
           client using the DOTS data channel.";
      }

      augment "/ietf-signal:dots-signal/ietf-signal:message-type/" +
              "ietf-signal:mitigation-scope/ietf-signal:scope" {
        if-feature control-filtering;

        description "ACL name and activation type";

        list acl-list {
          key "acl-name";
          description
            "List of ACLs as defined in the DOTS data
             channel.  These ACLs are uniquely defined by
             cuid and name.";
          leaf acl-name {
            type leafref {
              path "/ietf-data:dots-data/ietf-data:dots-client/" +
                   "ietf-data:acls/ietf-data:acl/ietf-data:name";
            }
            description
              "Reference to the ACL name bound to
               a DOTS client.";
          }
          leaf activation-type {
            type enumeration {
              enum "activate-when-mitigating" {
              value 1;
              description
                "The ACL is installed only when a mitigation is active. 
                 The ACL is specific to this DOTS client.";
              }
              enum "immediate" {
                value 2;
                description
                  "The ACL is immediately activated.";
              }
              enum "deactivate" {
                value 3;
                description
                 "The ACL is maintained by the server, but it is
                  deactivated.";
              }
            }
            description
              "Set the activation type of an ACL.";
          }
        }   
      }
}
<CODE ENDS>
]]></artwork>
              </figure></t>
          </section>
        </section>
      </section>
    </section>

    <section anchor="IANA" title="IANA Considerations">
      <section anchor="map" title="DOTS Signal Channel CBOR Mappings Registry">
        <t>This specification registers the 'activation-type' parameter in the
        IANA "DOTS Signal Channel CBOR Mappings" registry established by <xref
        target="I-D.ietf-dots-signal-channel"></xref>.</t>

        <t>The 'activation-type' is a comprehension-required parameter. The
        'acl-list' and 'acl-name' parameters are defined as
        comprehension-required parameters in Table 6 in <xref
        target="I-D.ietf-dots-signal-channel"></xref>. Following the rules in
        <xref target="I-D.ietf-dots-signal-channel"></xref>, if the DOTS
        server does not understand the 'acl-list' or 'acl-name' or
        'activation-type' attributes, it responds with a "4.00 (Bad Request)"
        error response code.</t>

        <t><list style="symbols">
            <t>Note to the RFC Editor: Please delete (TBD1) once the CBOR key
            is assigned from the 0x8000 - 0xBFFF range.</t>
          </list><figure align="center">
            <artwork><![CDATA[+-------------------+------------+--------+---------------+--------+
| Parameter Name    | YANG       | CBOR   | CBOR Major    | JSON   |
|                   | Type       | Key    |    Type &     | Type   |
|                   |            |        | Information   |        |
+-------------------+------------+--------+---------------+--------+
| activation-type   | enumeration| 0x0031 | 0 unsigned    | String |
|                   |            | (TBD1) |               |        |
+-------------------+------------+--------+---------------+--------+
]]></artwork>
          </figure></t>
      </section>

      <section anchor="yang-iana"
               title="DOTS Signal Control Filtering YANG Module">
        <t>This document requests IANA to register the following URI in the
        "IETF XML Registry" <xref target="RFC3688"></xref>: <figure>
            <artwork><![CDATA[   URI: urn:ietf:params:xml:ns:yang:ietf-dots-signal-control-filter
   Registrant Contact: The IESG.
   XML: N/A; the requested URI is an XML namespace.

]]></artwork>
          </figure> This document requests IANA to register the following YANG
        module in the "YANG Module Names" registry <xref
        target="RFC7950"></xref>.<figure>
            <artwork><![CDATA[  name: ietf-dots-signal-control-filter
  namespace: urn:ietf:params:xml:ns:yang:ietf-dots-signal-control-filter
  prefix: signal-control-filter
  reference: RFC XXXX

]]></artwork>
          </figure></t>
      </section>
    </section>

    <section anchor="security" title="Security Considerations">
      <t>The security considerations discussed in <xref
      target="I-D.ietf-dots-signal-channel"></xref> and <xref
      target="I-D.ietf-dots-data-channel"></xref> need to be taken into
      account.</t>
    </section>

    <section anchor="ack" title="Acknowledgements">
      <t>TBD</t>
    </section>
  </middle>

  <back>
    <references title="Normative References">
      <?rfc include="reference.RFC.2119"?>

      <?rfc include="reference.RFC.7950"?>

      <?rfc include="reference.RFC.3688"?>

      <?rfc include='reference.RFC.8174'?>

      <?rfc include="reference.I-D.ietf-dots-signal-channel"?>

      <?rfc include="reference.I-D.ietf-dots-data-channel" ?>

      <?rfc ?>
    </references>

    <references title="Informative References">
      <?rfc include="reference.I-D.ietf-dots-requirements"?>
    </references>
  </back>
</rfc>
