From 8eec0b5b062b5f98a865949ac0f2a49d61b81199 Mon Sep 17 00:00:00 2001
From: aapostoliuk <a.apostoliuk@vyos.io>
Date: Tue, 13 Feb 2024 18:55:13 +0200
Subject: T6029: Rewritten Accel-PPP services to an identical feature set

Removed dhcp-interface option (l2tp)
Added wins-server (sstp)
Added description (ipoe, pppoe, sstp, pptp)
Added exteded-script (l2tp, sstp, pptp)
Added shaper (ipoe, pptp, sstp, l2tp)
Added limits (ipoe, pptp, sstp, l2tp)
Added snmp ( ipoe, pptp,sstp, l2tp)
Refactoring and reformated code.

(cherry picked from commit ac6a16f6c5ad7700789759e1ec093236c2e182a2)
---
 .../include/accel-ppp/extended-scripts.xml.i       |  41 ++++++++
 .../include/accel-ppp/limits.xml.i                 |  28 ++++++
 interface-definitions/include/accel-ppp/snmp.xml.i |  15 +++
 .../include/version/l2tp-version.xml.i             |   2 +-
 interface-definitions/service_ipoe-server.xml.in   |  11 ++-
 interface-definitions/service_pppoe-server.xml.in  | 110 ++++-----------------
 interface-definitions/vpn_l2tp.xml.in              |  83 ++++++++--------
 interface-definitions/vpn_pptp.xml.in              |  23 +++--
 interface-definitions/vpn_sstp.xml.in              |  32 +++---
 9 files changed, 187 insertions(+), 158 deletions(-)
 create mode 100644 interface-definitions/include/accel-ppp/extended-scripts.xml.i
 create mode 100644 interface-definitions/include/accel-ppp/limits.xml.i
 create mode 100644 interface-definitions/include/accel-ppp/snmp.xml.i

(limited to 'interface-definitions')

diff --git a/interface-definitions/include/accel-ppp/extended-scripts.xml.i b/interface-definitions/include/accel-ppp/extended-scripts.xml.i
new file mode 100644
index 000000000..4bba76e32
--- /dev/null
+++ b/interface-definitions/include/accel-ppp/extended-scripts.xml.i
@@ -0,0 +1,41 @@
+<!-- include start from accel-ppp/extended-scripts.xml.i -->
+<node name="extended-scripts">
+  <properties>
+    <help>Extended script execution</help>
+  </properties>
+  <children>
+    <leafNode name="on-pre-up">
+      <properties>
+        <help>Script to run before PPPoE session interface comes up</help>
+          <constraint>
+            <validator name="script"/>
+          </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="on-up">
+      <properties>
+        <help>Script to run when PPPoE session interface is completely configured and started</help>
+          <constraint>
+            <validator name="script"/>
+          </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="on-down">
+      <properties>
+        <help>Script to run when PPPoE session interface going to terminate</help>
+          <constraint>
+            <validator name="script"/>
+          </constraint>
+      </properties>
+    </leafNode>
+    <leafNode name="on-change">
+      <properties>
+        <help>Script to run when PPPoE session interface changed by RADIUS CoA handling</help>
+          <constraint>
+            <validator name="script"/>
+          </constraint>
+      </properties>
+    </leafNode>
+  </children>
+</node>
+<!-- include end -->
diff --git a/interface-definitions/include/accel-ppp/limits.xml.i b/interface-definitions/include/accel-ppp/limits.xml.i
new file mode 100644
index 000000000..df72b79d4
--- /dev/null
+++ b/interface-definitions/include/accel-ppp/limits.xml.i
@@ -0,0 +1,28 @@
+<!-- include start from accel-ppp/limits.xml.i -->
+<node name="limits">
+  <properties>
+    <help>Limits the connection rate from a single source</help>
+  </properties>
+  <children>
+    <leafNode name="connection-limit">
+      <properties>
+        <help>Acceptable rate of connections (e.g. 1/min, 60/sec)</help>
+        <constraint>
+          <regex>[0-9]+\/(min|sec)</regex>
+        </constraint>
+        <constraintErrorMessage>illegal value</constraintErrorMessage>
+      </properties>
+    </leafNode>
+    <leafNode name="burst">
+      <properties>
+        <help>Burst count</help>
+      </properties>
+    </leafNode>
+    <leafNode name="timeout">
+      <properties>
+        <help>Timeout in seconds</help>
+      </properties>
+    </leafNode>
+  </children>
+</node>
+<!-- include end -->
diff --git a/interface-definitions/include/accel-ppp/snmp.xml.i b/interface-definitions/include/accel-ppp/snmp.xml.i
new file mode 100644
index 000000000..373ced16f
--- /dev/null
+++ b/interface-definitions/include/accel-ppp/snmp.xml.i
@@ -0,0 +1,15 @@
+<!-- include start from accel-ppp/snmp.xml.i -->
+<node name="snmp">
+  <properties>
+    <help>Enable SNMP</help>
+  </properties>
+  <children>
+    <leafNode name="master-agent">
+      <properties>
+        <help>Enable SNMP master agent mode</help>
+        <valueless />
+      </properties>
+    </leafNode>
+  </children>
+</node>
+<!-- include end -->
diff --git a/interface-definitions/include/version/l2tp-version.xml.i b/interface-definitions/include/version/l2tp-version.xml.i
index 01004c5a0..5397407fb 100644
--- a/interface-definitions/include/version/l2tp-version.xml.i
+++ b/interface-definitions/include/version/l2tp-version.xml.i
@@ -1,3 +1,3 @@
 <!-- include start from include/version/l2tp-version.xml.i -->
-<syntaxVersion component='l2tp' version='8'></syntaxVersion>
+<syntaxVersion component='l2tp' version='9'></syntaxVersion>
 <!-- include end -->
diff --git a/interface-definitions/service_ipoe-server.xml.in b/interface-definitions/service_ipoe-server.xml.in
index 23d6e54d1..414c9a731 100644
--- a/interface-definitions/service_ipoe-server.xml.in
+++ b/interface-definitions/service_ipoe-server.xml.in
@@ -177,13 +177,18 @@
               #include <include/accel-ppp/vlan.xml.i>
             </children>
           </tagNode>
-          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
-          #include <include/name-server-ipv4-ipv6.xml.i>
           #include <include/accel-ppp/client-ip-pool.xml.i>
-          #include <include/accel-ppp/gateway-address-multi.xml.i>
           #include <include/accel-ppp/client-ipv6-pool.xml.i>
           #include <include/accel-ppp/default-pool.xml.i>
           #include <include/accel-ppp/default-ipv6-pool.xml.i>
+          #include <include/accel-ppp/extended-scripts.xml.i>
+          #include <include/accel-ppp/gateway-address-multi.xml.i>
+          #include <include/accel-ppp/limits.xml.i>
+          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
+          #include <include/accel-ppp/shaper.xml.i>
+          #include <include/accel-ppp/snmp.xml.i>
+          #include <include/generic-description.xml.i>
+          #include <include/name-server-ipv4-ipv6.xml.i>
         </children>
       </node>
     </children>
diff --git a/interface-definitions/service_pppoe-server.xml.in b/interface-definitions/service_pppoe-server.xml.in
index 477ed115f..9b5e4d3fb 100644
--- a/interface-definitions/service_pppoe-server.xml.in
+++ b/interface-definitions/service_pppoe-server.xml.in
@@ -49,9 +49,6 @@
               </node>
             </children>
           </node>
-          #include <include/accel-ppp/client-ip-pool.xml.i>
-          #include <include/accel-ppp/client-ipv6-pool.xml.i>
-          #include <include/name-server-ipv4-ipv6.xml.i>
           <tagNode name="interface">
             <properties>
               <help>interface(s) to listen on</help>
@@ -63,35 +60,6 @@
               #include <include/accel-ppp/vlan.xml.i>
             </children>
           </tagNode>
-          #include <include/accel-ppp/gateway-address.xml.i>
-          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
-          #include <include/accel-ppp/mtu-128-16384.xml.i>
-          <node name="limits">
-            <properties>
-              <help>Limits the connection rate from a single source</help>
-            </properties>
-            <children>
-              <leafNode name="connection-limit">
-                <properties>
-                  <help>Acceptable rate of connections (e.g. 1/min, 60/sec)</help>
-                  <constraint>
-                    <regex>[0-9]+\/(min|sec)</regex>
-                  </constraint>
-                  <constraintErrorMessage>illegal value</constraintErrorMessage>
-                </properties>
-              </leafNode>
-              <leafNode name="burst">
-                <properties>
-                  <help>Burst count</help>
-                </properties>
-              </leafNode>
-              <leafNode name="timeout">
-                <properties>
-                  <help>Timeout in seconds</help>
-                </properties>
-              </leafNode>
-            </children>
-          </node>
           <leafNode name="service-name">
             <properties>
               <help>Service name</help>
@@ -102,15 +70,6 @@
               <multi/>
             </properties>
           </leafNode>
-          #include <include/accel-ppp/wins-server.xml.i>
-          #include <include/accel-ppp/ppp-options.xml.i>
-          <node name="ppp-options">
-            <children>
-              <leafNode name="min-mtu">
-                <defaultValue>1280</defaultValue>
-              </leafNode>
-            </children>
-          </node>
           <tagNode name="pado-delay">
             <properties>
               <help>PADO delays</help>
@@ -164,61 +123,28 @@
             </properties>
             <defaultValue>replace</defaultValue>
           </leafNode>
-          #include <include/accel-ppp/shaper.xml.i>
-          <node name="snmp">
-            <properties>
-              <help>Enable SNMP</help>
-            </properties>
-            <children>
-              <leafNode name="master-agent">
-                <properties>
-                  <help>enable SNMP master agent mode</help>
-                  <valueless />
-                </properties>
-              </leafNode>
-            </children>
-          </node>
-          <node name="extended-scripts">
-            <properties>
-              <help>Extended script execution</help>
-            </properties>
+          #include <include/accel-ppp/client-ip-pool.xml.i>
+          #include <include/accel-ppp/client-ipv6-pool.xml.i>
+          #include <include/accel-ppp/default-pool.xml.i>
+          #include <include/accel-ppp/default-ipv6-pool.xml.i>
+          #include <include/accel-ppp/extended-scripts.xml.i>
+          #include <include/accel-ppp/gateway-address.xml.i>
+          #include <include/accel-ppp/limits.xml.i>
+          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
+          #include <include/accel-ppp/mtu-128-16384.xml.i>
+          #include <include/accel-ppp/ppp-options.xml.i>
+          <node name="ppp-options">
             <children>
-              <leafNode name="on-pre-up">
-                <properties>
-                  <help>Script to run before PPPoE session interface comes up</help>
-                    <constraint>
-                      <validator name="script"/>
-                    </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="on-up">
-                <properties>
-                  <help>Script to run when PPPoE session interface is completely configured and started</help>
-                    <constraint>
-                      <validator name="script"/>
-                    </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="on-down">
-                <properties>
-                  <help>Script to run when PPPoE session interface going to terminate</help>
-                    <constraint>
-                      <validator name="script"/>
-                    </constraint>
-                </properties>
-              </leafNode>
-              <leafNode name="on-change">
-                <properties>
-                  <help>Script to run when PPPoE session interface changed by RADIUS CoA handling</help>
-                    <constraint>
-                      <validator name="script"/>
-                    </constraint>
-                </properties>
+              <leafNode name="min-mtu">
+                <defaultValue>1280</defaultValue>
               </leafNode>
             </children>
           </node>
-          #include <include/accel-ppp/default-pool.xml.i>
-          #include <include/accel-ppp/default-ipv6-pool.xml.i>
+          #include <include/accel-ppp/shaper.xml.i>
+          #include <include/accel-ppp/snmp.xml.i>
+          #include <include/accel-ppp/wins-server.xml.i>
+          #include <include/generic-description.xml.i>
+          #include <include/name-server-ipv4-ipv6.xml.i>
         </children>
       </node>
     </children>
diff --git a/interface-definitions/vpn_l2tp.xml.in b/interface-definitions/vpn_l2tp.xml.in
index 6148e3269..85a375db4 100644
--- a/interface-definitions/vpn_l2tp.xml.in
+++ b/interface-definitions/vpn_l2tp.xml.in
@@ -30,42 +30,6 @@
                   </node>
                 </children>
               </node>
-              #include <include/accel-ppp/max-concurrent-sessions.xml.i>
-              #include <include/accel-ppp/mtu-128-16384.xml.i>
-              <leafNode name="mtu">
-                <defaultValue>1436</defaultValue>
-              </leafNode>
-              <leafNode name="outside-address">
-                <properties>
-                  <help>External IP address to which VPN clients will connect</help>
-                  <constraint>
-                    <validator name="ipv4-address"/>
-                  </constraint>
-                </properties>
-              </leafNode>
-              #include <include/accel-ppp/gateway-address.xml.i>
-              #include <include/name-server-ipv4-ipv6.xml.i>
-              <node name="lns">
-                <properties>
-                  <help>L2TP Network Server (LNS)</help>
-                </properties>
-                <children>
-                  <leafNode name="shared-secret">
-                    <properties>
-                      <help>Tunnel password used to authenticate the client (LAC)</help>
-                    </properties>
-                  </leafNode>
-                  <leafNode name="host-name">
-                    <properties>
-                      <help>Sent to the client (LAC) in the Host-Name attribute</help>
-                      <constraint>
-                        #include <include/constraint/host-name.xml.i>
-                      </constraint>
-                      <constraintErrorMessage>Host-name must be alphanumeric and can contain hyphens</constraintErrorMessage>
-                    </properties>
-                  </leafNode>
-                </children>
-              </node>
               <node name="ipsec-settings">
                 <properties>
                   <help>Internet Protocol Security (IPsec) for remote access L2TP VPN</help>
@@ -129,14 +93,53 @@
                   #include <include/ipsec/ike-group.xml.i>
                 </children>
               </node>
-              #include <include/accel-ppp/wins-server.xml.i>
+              <node name="lns">
+                <properties>
+                  <help>L2TP Network Server (LNS)</help>
+                </properties>
+                <children>
+                  <leafNode name="shared-secret">
+                    <properties>
+                      <help>Tunnel password used to authenticate the client (LAC)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="host-name">
+                    <properties>
+                      <help>Sent to the client (LAC) in the Host-Name attribute</help>
+                      <constraint>
+                        #include <include/constraint/host-name.xml.i>
+                      </constraint>
+                      <constraintErrorMessage>Host-name must be alphanumeric and can contain hyphens</constraintErrorMessage>
+                    </properties>
+                  </leafNode>
+                </children>
+              </node>
+              <leafNode name="outside-address">
+                <properties>
+                  <help>External IP address to which VPN clients will connect</help>
+                  <constraint>
+                    <validator name="ipv4-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
               #include <include/accel-ppp/client-ip-pool.xml.i>
               #include <include/accel-ppp/client-ipv6-pool.xml.i>
-              #include <include/generic-description.xml.i>
-              #include <include/dhcp-interface.xml.i>
-              #include <include/accel-ppp/ppp-options.xml.i>
               #include <include/accel-ppp/default-pool.xml.i>
               #include <include/accel-ppp/default-ipv6-pool.xml.i>
+              #include <include/accel-ppp/extended-scripts.xml.i>
+              #include <include/accel-ppp/gateway-address.xml.i>
+              #include <include/accel-ppp/limits.xml.i>
+              #include <include/accel-ppp/max-concurrent-sessions.xml.i>
+              #include <include/accel-ppp/mtu-128-16384.xml.i>
+              <leafNode name="mtu">
+                <defaultValue>1436</defaultValue>
+              </leafNode>
+              #include <include/accel-ppp/ppp-options.xml.i>
+              #include <include/accel-ppp/shaper.xml.i>
+              #include <include/accel-ppp/snmp.xml.i>
+              #include <include/accel-ppp/wins-server.xml.i>
+              #include <include/generic-description.xml.i>
+              #include <include/name-server-ipv4-ipv6.xml.i>
             </children>
           </node>
         </children>
diff --git a/interface-definitions/vpn_pptp.xml.in b/interface-definitions/vpn_pptp.xml.in
index 2e2a3bec4..a63633f57 100644
--- a/interface-definitions/vpn_pptp.xml.in
+++ b/interface-definitions/vpn_pptp.xml.in
@@ -30,11 +30,6 @@
                   </node>
                 </children>
               </node>
-              #include <include/accel-ppp/max-concurrent-sessions.xml.i>
-              #include <include/accel-ppp/mtu-128-16384.xml.i>
-              <leafNode name="mtu">
-                <defaultValue>1436</defaultValue>
-              </leafNode>
               <leafNode name="outside-address">
                 <properties>
                   <help>External IP address to which VPN clients will connect</help>
@@ -43,14 +38,24 @@
                   </constraint>
                 </properties>
               </leafNode>
-              #include <include/accel-ppp/gateway-address.xml.i>
-              #include <include/name-server-ipv4-ipv6.xml.i>
-              #include <include/accel-ppp/wins-server.xml.i>
               #include <include/accel-ppp/client-ip-pool.xml.i>
-              #include <include/accel-ppp/default-pool.xml.i>
               #include <include/accel-ppp/client-ipv6-pool.xml.i>
+              #include <include/accel-ppp/default-pool.xml.i>
               #include <include/accel-ppp/default-ipv6-pool.xml.i>
+              #include <include/accel-ppp/extended-scripts.xml.i>
+              #include <include/accel-ppp/gateway-address.xml.i>
+              #include <include/accel-ppp/limits.xml.i>
+              #include <include/accel-ppp/max-concurrent-sessions.xml.i>
+              #include <include/accel-ppp/mtu-128-16384.xml.i>
+              <leafNode name="mtu">
+                <defaultValue>1436</defaultValue>
+              </leafNode>
               #include <include/accel-ppp/ppp-options.xml.i>
+              #include <include/accel-ppp/shaper.xml.i>
+              #include <include/accel-ppp/snmp.xml.i>
+              #include <include/accel-ppp/wins-server.xml.i>
+              #include <include/generic-description.xml.i>
+              #include <include/name-server-ipv4-ipv6.xml.i>
             </children>
           </node>
         </children>
diff --git a/interface-definitions/vpn_sstp.xml.in b/interface-definitions/vpn_sstp.xml.in
index 0d5d53301..d23a001d5 100644
--- a/interface-definitions/vpn_sstp.xml.in
+++ b/interface-definitions/vpn_sstp.xml.in
@@ -25,19 +25,6 @@
               </node>
             </children>
           </node>
-          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
-          #include <include/interface/mtu-68-1500.xml.i>
-          #include <include/accel-ppp/gateway-address.xml.i>
-          #include <include/name-server-ipv4-ipv6.xml.i>
-          #include <include/accel-ppp/client-ip-pool.xml.i>
-          #include <include/accel-ppp/client-ipv6-pool.xml.i>
-          #include <include/port-number.xml.i>
-          <leafNode name="port">
-            <defaultValue>443</defaultValue>
-          </leafNode>
-          #include <include/accel-ppp/default-pool.xml.i>
-          #include <include/accel-ppp/default-ipv6-pool.xml.i>
-          #include <include/accel-ppp/ppp-options.xml.i>
           <node name="ssl">
             <properties>
               <help>SSL Certificate, SSL Key and CA</help>
@@ -47,6 +34,25 @@
               #include <include/pki/certificate.xml.i>
             </children>
           </node>
+          #include <include/accel-ppp/client-ip-pool.xml.i>
+          #include <include/accel-ppp/client-ipv6-pool.xml.i>
+          #include <include/accel-ppp/default-pool.xml.i>
+          #include <include/accel-ppp/default-ipv6-pool.xml.i>
+          #include <include/accel-ppp/extended-scripts.xml.i>
+          #include <include/accel-ppp/gateway-address.xml.i>
+          #include <include/accel-ppp/limits.xml.i>
+          #include <include/accel-ppp/max-concurrent-sessions.xml.i>
+          #include <include/interface/mtu-68-1500.xml.i>
+          #include <include/port-number.xml.i>
+          <leafNode name="port">
+            <defaultValue>443</defaultValue>
+          </leafNode>
+          #include <include/accel-ppp/ppp-options.xml.i>
+          #include <include/accel-ppp/shaper.xml.i>
+          #include <include/accel-ppp/snmp.xml.i>
+          #include <include/accel-ppp/wins-server.xml.i>
+          #include <include/generic-description.xml.i>
+          #include <include/name-server-ipv4-ipv6.xml.i>
         </children>
       </node>
     </children>
-- 
cgit v1.2.3