nat: T2198: initial XML and Python representation

4 files changed, 256 insertions, 0 deletions

diff --git a/interface-definitions/include/nat-address-port.xml.i b/interface-definitions/include/nat-address-port.xml.i
new file mode 100644
index 000000000..0848364ff
--- /dev/null
+++ b/interface-definitions/include/nat-address-port.xml.i
@@ -0,0 +1,47 @@
+<leafNode name="address">
+  <properties>
+    <help>IP address, subnet, or range</help>
+    <valueHelp>
+      <format>ipv4</format>
+      <description>IPv4 address to match</description>
+    </valueHelp>
+    <valueHelp>
+      <format>ipv4net</format>
+      <description>IPv4 prefix to match</description>
+    </valueHelp>
+    <valueHelp>
+      <format>ipv4range</format>
+      <description>IPv4 address range to match</description>
+    </valueHelp>
+    <valueHelp>
+      <format>!ipv4</format>
+      <description>Match everything except the specified address</description>
+    </valueHelp>
+    <valueHelp>
+      <format>!ipv4net</format>
+      <description>Match everything except the specified prefix</description>
+    </valueHelp>
+    <valueHelp>
+      <format>!ipv4range</format>
+      <description>Match everything except the specified range</description>
+    </valueHelp>
+    <!-- TODO: add general iptables constraint script -->
+  </properties>
+</leafNode>
+<leafNode name="port">
+  <properties>
+    <help>Port number</help>
+    <valueHelp>
+      <format>1-65535</format>
+      <description>Numeric IP port</description>
+    </valueHelp>
+    <valueHelp>
+      <format>start-end</format>
+      <description>Numbered port range (e.g., 1001-1005)</description>
+    </valueHelp>
+    <valueHelp>
+      <format> </format>
+      <description>\n\nMultiple destination ports can be specified as a comma-separated list.\nThe whole list can also be negated using '!'.\nFor example: '!22,telnet,http,123,1001-1005'</description>
+    </valueHelp>
+  </properties>
+</leafNode>
diff --git a/interface-definitions/include/nat-rule.xml.i b/interface-definitions/include/nat-rule.xml.i
new file mode 100644
index 000000000..fdba4b8bd
--- /dev/null
+++ b/interface-definitions/include/nat-rule.xml.i
@@ -0,0 +1,86 @@
+<tagNode name="rule">
+  <properties>
+    <help>Rule number for NAT</help>
+    <valueHelp>
+      <format>1-9999</format>
+      <description>Number for this NAT rule</description>
+    </valueHelp>
+    <constraint>
+      <validator name="numeric" argument="--range 1-9999"/>
+    </constraint>
+    <constraintErrorMessage>NAT rule number must be between 1 and 9999</constraintErrorMessage>
+  </properties>
+  <children>
+    <leafNode name="description">
+      <properties>
+        <help>Rule description</help>
+      </properties>
+    </leafNode>
+    <node name="destination">
+      <properties>
+        <help>NAT destination parameters</help>
+      </properties>
+      <children>
+        #include <include/nat-address-port.xml.i>
+      </children>
+    </node>
+    <leafNode name="disable">
+      <properties>
+        <help>Disable NAT rule</help>
+        <valueless/>
+      </properties>
+    </leafNode>
+    <leafNode name="exclude">
+      <properties>
+        <help>Exclude packets matching this rule from NAT</help>
+        <valueless/>
+      </properties>
+    </leafNode>
+    <leafNode name="log">
+      <properties>
+        <help>NAT rule logging</help>
+        <valueless/>
+      </properties>
+    </leafNode>
+    <leafNode name="protocol">
+      <properties>
+        <help>Protocol to NAT</help>
+        <completionHelp>
+          <list>tcp udp tcp_udp all</list>
+        </completionHelp>
+        <valueHelp>
+          <format>tcp</format>
+          <description>Transmission Control Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>udp</format>
+          <description>User Datagram Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>tcp_udp</format>
+          <description>Both TCP and UDP</description>
+        </valueHelp>
+        <valueHelp>
+          <format>all</format>
+          <description>All IP protocols</description>
+        </valueHelp>
+        <valueHelp>
+          <format>0-255</format>
+          <description>IP protocol number</description>
+        </valueHelp>
+        <valueHelp>
+          <format>!&lt;protocol&gt;</format>
+          <description>All IP protocols except for the specified name or number (negation)</description>
+        </valueHelp>
+      </properties>
+    </leafNode>
+    <node name="source">
+      <properties>
+        <help>NAT source parameters</help>
+      </properties>
+      <children>
+        #include <include/nat-address-port.xml.i>
+      </children>
+    </node>
+  </children>
+</tagNode>
diff --git a/interface-definitions/include/nat-translation-port.xml.i b/interface-definitions/include/nat-translation-port.xml.i
new file mode 100644
index 000000000..93de471e3
--- /dev/null
+++ b/interface-definitions/include/nat-translation-port.xml.i
@@ -0,0 +1,13 @@
+<leafNode name="port">
+  <properties>
+    <help>Port number</help>
+    <valueHelp>
+      <format>1-65535</format>
+      <description>Numeric IP port</description>
+    </valueHelp>
+    <valueHelp>
+      <format>&lt;start&gt;-&lt;end&gt;</format>
+      <description>Numbered port range (e.g., 1001-1005)</description>
+    </valueHelp>
+  </properties>
+</leafNode>
diff --git a/interface-definitions/nat.xml.in b/interface-definitions/nat.xml.in
new file mode 100644
index 000000000..bcbdb37af
--- /dev/null
+++ b/interface-definitions/nat.xml.in
@@ -0,0 +1,110 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="nat" owner="sudo ${vyos_conf_scripts_dir}/nat.py">
+    <properties>
+      <help>Network Address Translation (NAT) parameters</help>
+      <priority>220</priority>
+    </properties>
+    <children>
+      <node name="destination">
+        <properties>
+          <help>Destination NAT settings</help>
+        </properties>
+        <children>
+          #include <include/nat-rule.xml.i>
+          <tagNode name="rule">
+            <children>
+              <leafNode name="inbound-interface">
+                <properties>
+                  <help>Inbound interface of NAT traffic</help>
+                  <completionHelp>
+                    <script>${vyos_completion_dir}/list_interfaces.py</script>
+                  </completionHelp>
+                </properties>
+              </leafNode>
+              <node name="translation">
+                <properties>
+                  <help>Inside NAT IP (destination NAT only)</help>
+                </properties>
+                <children>
+                  <leafNode name="address">
+                    <properties>
+                      <help>IP address, subnet, or range</help>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>IPv4 address to match</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>ipv4net</format>
+                        <description>IPv4 prefix to match</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>ipv4range</format>
+                        <description>IPv4 address range to match</description>
+                      </valueHelp>
+                      <!-- TODO: add general iptables constraint script -->
+                    </properties>
+                  </leafNode>
+                  #include <include/nat-translation-port.xml.i>
+                </children>
+              </node>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+      <node name="source">
+        <properties>
+          <help>Source NAT settings</help>
+        </properties>
+        <children>
+          #include <include/nat-rule.xml.i>
+          <tagNode name="rule">
+            <children>
+              <leafNode name="outbound-interface">
+                <properties>
+                  <help>Outbound interface of NAT traffic</help>
+                  <completionHelp>
+                    <script>${vyos_completion_dir}/list_interfaces.py</script>
+                  </completionHelp>
+                </properties>
+              </leafNode>
+              <node name="translation">
+                <properties>
+                  <help>Outside NAT IP (source NAT only)</help>
+                </properties>
+                <children>
+                  <leafNode name="address">
+                    <properties>
+                      <help>IP address, subnet, or range</help>
+                      <completionHelp>
+                        <list>masquerade</list>
+                      </completionHelp>
+                      <valueHelp>
+                        <format>ipv4</format>
+                        <description>IPv4 address to match</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>ipv4net</format>
+                        <description>IPv4 prefix to match</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>ipv4range</format>
+                        <description>IPv4 address range to match</description>
+                      </valueHelp>
+                      <valueHelp>
+                        <format>masquerade</format>
+                        <description>NAT to the primary address of outbound-interface</description>
+                      </valueHelp>
+                      <!-- TODO: add general iptables constraint script -->
+                    </properties>
+                  </leafNode>
+                  #include <include/nat-translation-port.xml.i>
+                </children>
+              </node>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>