Merge pull request #3039 from dmbaturin/T3420-no-upnp-for-now1.4.0-epa1

upnp: T3420: disable the UPnP CLI in Sagitta until bugs are fixed

2 files changed, 0 insertions, 334 deletions

diff --git a/interface-definitions/service_upnp.xml.in b/interface-definitions/service_upnp.xml.in
deleted file mode 100644
index 064386ee5..000000000
--- a/interface-definitions/service_upnp.xml.in
+++ /dev/null
@@ -1,229 +0,0 @@
-<?xml version="1.0"?>
-<interfaceDefinition>
-  <node name="service">
-    <children>
-      <node name="upnp" owner="${vyos_conf_scripts_dir}/service_upnp.py">
-        <properties>
-          <help>Universal Plug and Play (UPnP) service</help>
-          <priority>900</priority>
-        </properties>
-        <children>
-          <leafNode name="friendly-name">
-            <properties>
-              <help>Name of this service</help>
-              <valueHelp>
-                <format>txt</format>
-                <description>Friendly name</description>
-              </valueHelp>
-            </properties>
-          </leafNode>
-          <leafNode name="wan-interface">
-            <properties>
-              <help>WAN network interface</help>
-              <completionHelp>
-                <script>${vyos_completion_dir}/list_interfaces</script>
-              </completionHelp>
-              <constraint>
-                #include <include/constraint/interface-name.xml.i>
-              </constraint>
-            </properties>
-          </leafNode>
-          <leafNode name="wan-ip">
-            <properties>
-              <help>WAN network IP</help>
-              <valueHelp>
-                <format>ipv4</format>
-                <description>IPv4 address</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv6</format>
-                <description>IPv6 address</description>
-              </valueHelp>
-              <constraint>
-                <validator name="ipv4-address" />
-                <validator name="ipv6-address" />
-              </constraint>
-              <multi/>
-            </properties>
-          </leafNode>
-          <leafNode name="nat-pmp">
-            <properties>
-              <help>Enable NAT-PMP support</help>
-              <valueless />
-            </properties>
-          </leafNode>
-          <leafNode name="secure-mode">
-            <properties>
-              <help>Enable Secure Mode</help>
-              <valueless />
-            </properties>
-          </leafNode>
-          <leafNode name="presentation-url">
-            <properties>
-              <help>Presentation Url</help>
-              <valueHelp>
-                <format>txt</format>
-                <description>Presentation Url</description>
-              </valueHelp>
-            </properties>
-          </leafNode>
-          <node name="pcp-lifetime">
-            <properties>
-              <help>PCP-base lifetime Option</help>
-            </properties>
-            <children>
-              <leafNode name="max">
-                <properties>
-                  <help>Max lifetime time</help>
-                  <constraint>
-                    <validator name="numeric" />
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="min">
-                <properties>
-                  <help>Min lifetime time</help>
-                  <constraint>
-                    <validator name="numeric" />
-                  </constraint>
-                </properties>
-              </leafNode>
-            </children>
-          </node>
-          <leafNode name="listen">
-            <properties>
-              <help>Local IP addresses for service to listen on</help>
-              <completionHelp>
-                <script>${vyos_completion_dir}/list_local_ips.sh --both</script>
-                <script>${vyos_completion_dir}/list_interfaces</script>
-              </completionHelp>
-              <valueHelp>
-                <format>&lt;interface&gt;</format>
-                <description>Monitor interface address</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv4</format>
-                <description>IPv4 address to listen for incoming connections</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv4net</format>
-                <description>IPv4 prefix to listen for incoming connections</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv6</format>
-                <description>IPv6 address to listen for incoming connections</description>
-              </valueHelp>
-              <valueHelp>
-                <format>ipv6net</format>
-                <description>IPv6 prefix to listen for incoming connections</description>
-              </valueHelp>
-              <multi/>
-              <constraint>
-                #include <include/constraint/interface-name.xml.i>
-                <validator name="ip-address"/>
-                <validator name="ipv4-prefix"/>
-                <validator name="ipv6-prefix"/>
-              </constraint>
-            </properties>
-          </leafNode>
-          <node name="stun">
-            <properties>
-              <help>Enable STUN probe support (can be used with NAT 1:1 support for WAN interfaces)</help>
-            </properties>
-            <children>
-              <leafNode name="host">
-                <properties>
-                  <help>The STUN server address</help>
-                  <valueHelp>
-                    <format>txt</format>
-                    <description>The STUN server host address</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="fqdn"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              #include <include/port-number.xml.i>
-            </children>
-          </node>
-          <tagNode name="rule">
-            <properties>
-              <help>UPnP Rule</help>
-              <valueHelp>
-                <format>u32:0-65535</format>
-                <description>Rule number</description>
-              </valueHelp>
-              <constraint>
-                <validator name="numeric" argument="--range 0-65535"/>
-              </constraint>
-            </properties>
-            <children>
-              #include <include/generic-disable-node.xml.i>
-              <leafNode name="external-port-range">
-                <properties>
-                  <help>Port range (REQUIRE)</help>
-                  <valueHelp>
-                    <format>&lt;port&gt;</format>
-                    <description>single port</description>
-                  </valueHelp>
-                  <valueHelp>
-                    <format>&lt;portN&gt;-&lt;portM&gt;</format>
-                    <description>Port range (use '-' as delimiter)</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="port-range"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="internal-port-range">
-                <properties>
-                  <help>Port range (REQUIRE)</help>
-                  <valueHelp>
-                    <format>&lt;port&gt;</format>
-                    <description>single port</description>
-                  </valueHelp>
-                  <valueHelp>
-                    <format>&lt;portN&gt;-&lt;portM&gt;</format>
-                    <description>Port range (use '-' as delimiter)</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="port-range"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="ip">
-                <properties>
-                  <help>The IP to which this rule applies (REQUIRE)</help>
-                  <valueHelp>
-                    <format>ipv4</format>
-                    <description>The IPv4 address to which this rule applies</description>
-                  </valueHelp>
-                  <valueHelp>
-                    <format>ipv4net</format>
-                    <description>The IPv4 to which this rule applies</description>
-                  </valueHelp>
-                  <constraint>
-                    <validator name="ipv4-address"/>
-                    <validator name="ipv4-host"/>
-                    <validator name="ipv4-prefix"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="action">
-                <properties>
-                  <help>Actions against the rule (REQUIRE)</help>
-                  <completionHelp>
-                    <list>allow deny</list>
-                  </completionHelp>
-                  <constraint>
-                    <regex>(allow|deny)</regex>
-                  </constraint>
-                </properties>
-              </leafNode>
-            </children>
-          </tagNode>
-        </children>
-      </node>
-    </children>
-  </node>
-</interfaceDefinition>
diff --git a/smoketest/scripts/cli/test_service_upnp.py b/smoketest/scripts/cli/test_service_upnp.py
deleted file mode 100755
index c3fb0ec9d..000000000
--- a/smoketest/scripts/cli/test_service_upnp.py
+++ /dev/null
@@ -1,105 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2021-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/>.
-
-import re
-import unittest
-
-from base_vyostest_shim import VyOSUnitTestSHIM
-
-from vyos.configsession import ConfigSession
-from vyos.configsession import ConfigSessionError
-from vyos.template import ip_from_cidr
-from vyos.utils.file import read_file
-from vyos.utils.process import process_named_running
-
-UPNP_CONF = '/run/upnp/miniupnp.conf'
-DAEMON = 'miniupnpd'
-interface = 'eth0'
-base_path = ['service', 'upnp']
-address_base = ['interfaces', 'ethernet', interface, 'address']
-
-ipv4_addr = '100.64.0.1/24'
-ipv6_addr = '2001:db8::1/64'
-
-class TestServiceUPnP(VyOSUnitTestSHIM.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        super(TestServiceUPnP, cls).setUpClass()
-
-        # ensure we can also run this test on a live system - so lets clean
-        # out the current configuration :)
-        cls.cli_delete(cls, base_path)
-
-        cls.cli_set(cls, address_base + [ipv4_addr])
-        cls.cli_set(cls, address_base + [ipv6_addr])
-
-    @classmethod
-    def tearDownClass(cls):
-        cls.cli_delete(cls, address_base)
-        cls._session.commit()
-
-        super(TestServiceUPnP, cls).tearDownClass()
-
-    def tearDown(self):
-        # Check for running process
-        self.assertTrue(process_named_running(DAEMON))
-
-        self.cli_delete(base_path)
-        self.cli_commit()
-
-        # Check for running process
-        self.assertFalse(process_named_running(DAEMON))
-
-    def test_ipv4_base(self):
-        self.cli_set(base_path + ['nat-pmp'])
-        self.cli_set(base_path + ['listen', interface])
-
-        # check validate() - WAN interface is mandatory
-        with self.assertRaises(ConfigSessionError):
-            self.cli_commit()
-        self.cli_set(base_path + ['wan-interface', interface])
-
-        self.cli_commit()
-
-        config = read_file(UPNP_CONF)
-        self.assertIn(f'ext_ifname={interface}', config)
-        self.assertIn(f'listening_ip={interface}', config)
-        self.assertIn(f'enable_natpmp=yes', config)
-        self.assertIn(f'enable_upnp=yes', config)
-
-    def test_ipv6_base(self):
-        v6_addr = ip_from_cidr(ipv6_addr)
-
-        self.cli_set(base_path + ['nat-pmp'])
-        self.cli_set(base_path + ['listen', interface])
-        self.cli_set(base_path + ['listen', v6_addr])
-
-        # check validate() - WAN interface is mandatory
-        with self.assertRaises(ConfigSessionError):
-            self.cli_commit()
-        self.cli_set(base_path + ['wan-interface', interface])
-
-        self.cli_commit()
-
-        config = read_file(UPNP_CONF)
-        self.assertIn(f'ext_ifname={interface}', config)
-        self.assertIn(f'listening_ip={interface}', config)
-        self.assertIn(f'ipv6_listening_ip={v6_addr}', config)
-        self.assertIn(f'enable_natpmp=yes', config)
-        self.assertIn(f'enable_upnp=yes', config)
-
-if __name__ == '__main__':
-    unittest.main(verbosity=2)