Merge pull request #1545 from sever-sever/T4557

ids: T4557: Migrate threshold and add new threshold types

6 files changed, 184 insertions, 39 deletions

diff --git a/data/templates/ids/fastnetmon.j2 b/data/templates/ids/fastnetmon.j2
index b9f77a257..0340d3c92 100644
--- a/data/templates/ids/fastnetmon.j2
+++ b/data/templates/ids/fastnetmon.j2
@@ -37,18 +37,70 @@ process_incoming_traffic = {{ 'on' if direction is vyos_defined and 'in' in dire
 process_outgoing_traffic = {{ 'on' if direction is vyos_defined and 'out' in direction else 'off' }}
 
 {% if threshold is vyos_defined %}
-{%     for thr, thr_value in threshold.items() %}
-{%         if thr is vyos_defined('fps') %}
+{%     if threshold.general is vyos_defined %}
+# General threshold
+{%         for thr, thr_value in threshold.general.items() %}
+{%             if thr is vyos_defined('fps') %}
 ban_for_flows = on
 threshold_flows = {{ thr_value }}
-{%         elif thr is vyos_defined('mbps') %}
+{%             elif thr is vyos_defined('mbps') %}
 ban_for_bandwidth = on
 threshold_mbps = {{ thr_value }}
-{%         elif thr is vyos_defined('pps') %}
+{%             elif thr is vyos_defined('pps') %}
 ban_for_pps = on
 threshold_pps = {{ thr_value }}
-{%         endif %}
-{%     endfor %}
+{%             endif %}
+{%         endfor %}
+{%     endif %}
+
+{%     if threshold.tcp is vyos_defined %}
+# TCP threshold
+{%         for thr, thr_value in threshold.tcp.items() %}
+{%             if thr is vyos_defined('fps') %}
+ban_for_tcp_flows = on
+threshold_tcp_flows = {{ thr_value }}
+{%             elif thr is vyos_defined('mbps') %}
+ban_for_tcp_bandwidth = on
+threshold_tcp_mbps = {{ thr_value }}
+{%             elif thr is vyos_defined('pps') %}
+ban_for_tcp_pps = on
+threshold_tcp_pps = {{ thr_value }}
+{%             endif %}
+{%         endfor %}
+{%     endif %}
+
+{%     if threshold.udp is vyos_defined %}
+# UDP threshold
+{%         for thr, thr_value in threshold.udp.items() %}
+{%             if thr is vyos_defined('fps') %}
+ban_for_udp_flows = on
+threshold_udp_flows = {{ thr_value }}
+{%             elif thr is vyos_defined('mbps') %}
+ban_for_udp_bandwidth = on
+threshold_udp_mbps = {{ thr_value }}
+{%             elif thr is vyos_defined('pps') %}
+ban_for_udp_pps = on
+threshold_udp_pps = {{ thr_value }}
+{%             endif %}
+{%         endfor %}
+{%     endif %}
+
+{%     if threshold.icmp is vyos_defined %}
+# ICMP threshold
+{%         for thr, thr_value in threshold.icmp.items() %}
+{%             if thr is vyos_defined('fps') %}
+ban_for_icmp_flows = on
+threshold_icmp_flows = {{ thr_value }}
+{%             elif thr is vyos_defined('mbps') %}
+ban_for_icmp_bandwidth = on
+threshold_icmp_mbps = {{ thr_value }}
+{%             elif thr is vyos_defined('pps') %}
+ban_for_icmp_pps = on
+threshold_icmp_pps = {{ thr_value }}
+{%             endif %}
+{%         endfor %}
+{%     endif %}
+
 {% endif %}
 
 {% if listen_interface is vyos_defined %}
diff --git a/interface-definitions/include/ids/threshold.xml.i b/interface-definitions/include/ids/threshold.xml.i
new file mode 100644
index 000000000..e21e3a005
--- /dev/null
+++ b/interface-definitions/include/ids/threshold.xml.i
@@ -0,0 +1,38 @@
+<!-- include start from ids/threshold.xml.i -->
+<leafNode name="fps">
+  <properties>
+    <help>Flows per second</help>
+    <valueHelp>
+      <format>u32:0-4294967294</format>
+      <description>Flows per second</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 0-4294967294"/>
+    </constraint>
+  </properties>
+</leafNode>
+<leafNode name="mbps">
+  <properties>
+    <help>Megabits per second</help>
+    <valueHelp>
+      <format>u32:0-4294967294</format>
+      <description>Megabits per second</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 0-4294967294"/>
+    </constraint>
+  </properties>
+</leafNode>
+<leafNode name="pps">
+  <properties>
+    <help>Packets per second</help>
+    <valueHelp>
+      <format>u32:0-4294967294</format>
+      <description>Packets per second</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 0-4294967294"/>
+    </constraint>
+  </properties>
+</leafNode>
+<!-- include end -->
diff --git a/interface-definitions/include/version/ids-version.xml.i b/interface-definitions/include/version/ids-version.xml.i
new file mode 100644
index 000000000..9133be02b
--- /dev/null
+++ b/interface-definitions/include/version/ids-version.xml.i
@@ -0,0 +1,3 @@
+<!-- include start from include/version/ids-version.xml.i -->
+<syntaxVersion component='ids' version='1'></syntaxVersion>
+<!-- include end -->
diff --git a/interface-definitions/service-ids-ddos-protection.xml.in b/interface-definitions/service-ids-ddos-protection.xml.in
index 86fc4dffa..a661b845d 100644
--- a/interface-definitions/service-ids-ddos-protection.xml.in
+++ b/interface-definitions/service-ids-ddos-protection.xml.in
@@ -107,42 +107,38 @@
                   <help>Attack limits thresholds</help>
                 </properties>
                 <children>
-                  <leafNode name="fps">
+                  <node name="general">
                     <properties>
-                      <help>Flows per second</help>
-                      <valueHelp>
-                        <format>u32:0-4294967294</format>
-                        <description>Flows per second</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="numeric" argument="--range 0-4294967294"/>
-                      </constraint>
+                      <help>General threshold</help>
                     </properties>
-                  </leafNode>
-                  <leafNode name="mbps">
+                    <children>
+                      #include <include/ids/threshold.xml.i>
+                    </children>
+                  </node>
+                  <node name="tcp">
                     <properties>
-                      <help>Megabits per second</help>
-                      <valueHelp>
-                        <format>u32:0-4294967294</format>
-                        <description>Megabits per second</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="numeric" argument="--range 0-4294967294"/>
-                      </constraint>
+                      <help>TCP threshold</help>
                     </properties>
-                  </leafNode>
-                  <leafNode name="pps">
+                    <children>
+                      #include <include/ids/threshold.xml.i>
+                    </children>
+                  </node>
+                  <node name="udp">
                     <properties>
-                      <help>Packets per second</help>
-                      <valueHelp>
-                        <format>u32:0-4294967294</format>
-                        <description>Packets per second</description>
-                      </valueHelp>
-                      <constraint>
-                        <validator name="numeric" argument="--range 0-4294967294"/>
-                      </constraint>
+                      <help>UDP threshold</help>
                     </properties>
-                  </leafNode>
+                    <children>
+                      #include <include/ids/threshold.xml.i>
+                    </children>
+                  </node>
+                  <node name="icmp">
+                    <properties>
+                      <help>ICMP threshold</help>
+                    </properties>
+                    <children>
+                      #include <include/ids/threshold.xml.i>
+                    </children>
+                  </node>
                 </children>
               </node>
             </children>
diff --git a/smoketest/scripts/cli/test_service_ids.py b/smoketest/scripts/cli/test_service_ids.py
index d471eeaed..dcf2bcefe 100755
--- a/smoketest/scripts/cli/test_service_ids.py
+++ b/smoketest/scripts/cli/test_service_ids.py
@@ -77,9 +77,9 @@ class TestServiceIDS(VyOSUnitTestSHIM.TestCase):
             self.cli_set(base_path + ['listen-interface', tmp])
 
         self.cli_set(base_path + ['direction', 'in'])
-        self.cli_set(base_path + ['threshold', 'fps', fps])
-        self.cli_set(base_path + ['threshold', 'pps', pps])
-        self.cli_set(base_path + ['threshold', 'mbps', mbps])
+        self.cli_set(base_path + ['threshold', 'general', 'fps', fps])
+        self.cli_set(base_path + ['threshold', 'general', 'pps', pps])
+        self.cli_set(base_path + ['threshold', 'general', 'mbps', mbps])
 
         # commit changes
         self.cli_commit()
diff --git a/src/migration-scripts/ids/0-to-1 b/src/migration-scripts/ids/0-to-1
new file mode 100755
index 000000000..9f08f7dc7
--- /dev/null
+++ b/src/migration-scripts/ids/0-to-1
@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from sys import argv
+from sys import exit
+
+from vyos.configtree import ConfigTree
+
+if (len(argv) < 1):
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+base = ['service', 'ids', 'ddos-protection']
+config = ConfigTree(config_file)
+
+if not config.exists(base + ['threshold']):
+    # Nothing to do
+    exit(0)
+else:
+    if config.exists(base + ['threshold', 'fps']):
+        tmp = config.return_value(base + ['threshold', 'fps'])
+        config.delete(base + ['threshold', 'fps'])
+        config.set(base + ['threshold', 'general', 'fps'], value=tmp)
+    if config.exists(base + ['threshold', 'mbps']):
+        tmp = config.return_value(base + ['threshold', 'mbps'])
+        config.delete(base + ['threshold', 'mbps'])
+        config.set(base + ['threshold', 'general', 'mbps'], value=tmp)
+    if config.exists(base + ['threshold', 'pps']):
+        tmp = config.return_value(base + ['threshold', 'pps'])
+        config.delete(base + ['threshold', 'pps'])
+        config.set(base + ['threshold', 'general', 'pps'], value=tmp)
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print(f'Failed to save the modified config: {e}')
+    exit(1)