Merge branch 'nat-nftables' of github.com:c-po/vyos-1x into current

* 'nat-nftables' of github.com:c-po/vyos-1x: (27 commits)
  nat: T2198: remove "tcp_udp" from "show nat dest stat"x
  Debian: add required dependency on systemd
  nat: T2198: add common ip-protocol validator
  nat: T2198: use Jinja2 macro for common ruleset for SNAT and DNAT
  nat: T2198: restructure DNAT template part for less duplicated code
  nat: T2198: add support for SNAT based on source addresses
  nat: T2198: set default protocol to all to be backwards compatible
  nat: T2198: sync generated SNAT rules with VyOS 1.2
  nat: T2198: sync generated DNAT rules with VyOS 1.2
  nat: T2198: do not run DNAT rule if rule is disabled
  nat: T2198: restructure DNAT template
  nat: T2198: verify translation address for SNAT and DNAT
  nat: T2198: extend verify() for destination ports
  nat: T2198: migrate "log enable" node to only "log"
  nat: T2198: add protocol completion helper and regex constraint
  nat: T2198: migrate "show nat" commands to XML and Python
  nat: T2198: add some basic verify() rules
  nat: T2198: split nat-address-port include into individual files
  nat: T2198: add ipv4-{address,prefix,rage}-exclude validators
  nat: T2198: add new ipv4-range validator
  ...

5 files changed, 485 insertions, 0 deletions

diff --git a/interface-definitions/include/nat-address.xml.i b/interface-definitions/include/nat-address.xml.i
new file mode 100644
index 000000000..933dae07b
--- /dev/null
+++ b/interface-definitions/include/nat-address.xml.i
@@ -0,0 +1,37 @@
+<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>
+    <constraint>
+      <validator name="ipv4-address"/>
+      <validator name="ipv4-prefix"/>
+      <validator name="ipv4-range"/>
+      <validator name="ipv4-address-exclude"/>
+      <validator name="ipv4-prefix-exclude"/>
+      <validator name="ipv4-range-exclude"/>
+    </constraint>
+  </properties>
+</leafNode>
diff --git a/interface-definitions/include/nat-port.xml.i b/interface-definitions/include/nat-port.xml.i
new file mode 100644
index 000000000..24803ae05
--- /dev/null
+++ b/interface-definitions/include/nat-port.xml.i
@@ -0,0 +1,17 @@
+<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..f62a08987
--- /dev/null
+++ b/interface-definitions/include/nat-rule.xml.i
@@ -0,0 +1,303 @@
+<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.xml.i>
+        #include <include/nat-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>all ip hopopt icmp igmp ggp ipencap st tcp egp igp pup udp tcp_udp hmp xns-idp rdp iso-tp4 dccp xtp ddp idpr-cmtp ipv6 ipv6-route ipv6-frag idrp rsvp gre esp ah skip ipv6-icmp ipv6-nonxt ipv6-opts rspf vmtp eigrp ospf ax.25 ipip etherip encap 99 pim ipcomp vrrp l2tp isis sctp fc mobility-header udplite mpls-in-ip manet hip shim6 wesp rohc</list>
+        </completionHelp>
+        <valueHelp>
+          <format>all</format>
+          <description>All IP protocols</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ip</format>
+          <description>Internet Protocol, pseudo protocol number</description>
+        </valueHelp>
+        <valueHelp>
+          <format>hopopt</format>
+          <description>IPv6 Hop-by-Hop Option [RFC1883]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>icmp</format>
+          <description>internet control message protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>igmp</format>
+          <description>Internet Group Management</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ggp</format>
+          <description>gateway-gateway protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipencap</format>
+          <description>IP encapsulated in IP (officially IP)</description>
+        </valueHelp>
+        <valueHelp>
+          <format>st</format>
+          <description>ST datagram mode</description>
+        </valueHelp>
+        <valueHelp>
+          <format>tcp</format>
+          <description>transmission control protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>egp</format>
+          <description>exterior gateway protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>igp</format>
+          <description>any private interior gateway (Cisco)</description>
+        </valueHelp>
+        <valueHelp>
+          <format>pup</format>
+          <description>PARC universal packet 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>hmp</format>
+          <description>host monitoring protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>xns-idp</format>
+          <description>Xerox NS IDP</description>
+        </valueHelp>
+        <valueHelp>
+          <format>rdp</format>
+          <description>"reliable datagram" protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>iso-tp4</format>
+          <description>ISO Transport Protocol class 4 [RFC905]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>dccp</format>
+          <description>Datagram Congestion Control Prot. [RFC4340]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>xtp</format>
+          <description>Xpress Transfer Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ddp</format>
+          <description>Datagram Delivery Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>idpr-cmtp</format>
+          <description>IDPR Control Message Transport</description>
+        </valueHelp>
+        <valueHelp>
+          <format>Ipv6</format>
+          <description>Internet Protocol, version 6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv6-route</format>
+          <description>Routing Header for IPv6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv6-frag</format>
+          <description>Fragment Header for IPv6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>idrp</format>
+          <description>Inter-Domain Routing Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>rsvp</format>
+          <description>Reservation Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>gre</format>
+          <description>General Routing Encapsulation</description>
+        </valueHelp>
+        <valueHelp>
+          <format>esp</format>
+          <description>Encap Security Payload [RFC2406]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ah</format>
+          <description>Authentication Header [RFC2402]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>skip</format>
+          <description>SKIP</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv6-icmp</format>
+          <description>ICMP for IPv6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv6-nonxt</format>
+          <description>No Next Header for IPv6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipv6-opts</format>
+          <description>Destination Options for IPv6</description>
+        </valueHelp>
+        <valueHelp>
+          <format>rspf</format>
+          <description>Radio Shortest Path First (officially CPHB)</description>
+        </valueHelp>
+        <valueHelp>
+          <format>vmtp</format>
+          <description>Versatile Message Transport</description>
+        </valueHelp>
+        <valueHelp>
+          <format>eigrp</format>
+          <description>Enhanced Interior Routing Protocol (Cisco)</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ospf</format>
+          <description>Open Shortest Path First IGP</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ax.25</format>
+          <description>AX.25 frames</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipip</format>
+          <description>IP-within-IP Encapsulation Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>etherip</format>
+          <description>Ethernet-within-IP Encapsulation [RFC3378]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>encap</format>
+          <description>Yet Another IP encapsulation [RFC1241]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>99</format>
+          <description>Any private encryption scheme</description>
+        </valueHelp>
+        <valueHelp>
+          <format>pim</format>
+          <description>Protocol Independent Multicast</description>
+        </valueHelp>
+        <valueHelp>
+          <format>ipcomp</format>
+          <description>IP Payload Compression Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>vrrp</format>
+          <description>Virtual Router Redundancy Protocol [RFC5798]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>l2tp</format>
+          <description>Layer Two Tunneling Protocol [RFC2661]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>isis</format>
+          <description>IS-IS over IPv4</description>
+        </valueHelp>
+        <valueHelp>
+          <format>sctp</format>
+          <description>Stream Control Transmission Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>fc</format>
+          <description>Fibre Channel</description>
+        </valueHelp>
+        <valueHelp>
+          <format>mobility-header</format>
+          <description>Mobility Support for IPv6 [RFC3775]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>udplite</format>
+          <description>UDP-Lite [RFC3828]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>mpls-in-ip</format>
+          <description>MPLS-in-IP [RFC4023]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>manet</format>
+          <description>MANET Protocols [RFC5498]</description>
+        </valueHelp>
+        <valueHelp>
+          <format>hip</format>
+          <description>Host Identity Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>shim6</format>
+          <description>Shim6 Protocol</description>
+        </valueHelp>
+        <valueHelp>
+          <format>wesp</format>
+          <description>Wrapped Encapsulating Security Payload</description>
+        </valueHelp>
+        <valueHelp>
+          <format>rohc</format>
+          <description>Robust Header Compression</description>
+        </valueHelp>
+        <valueHelp>
+          <format>0-255</format>
+          <description>IP protocol number</description>
+        </valueHelp>
+        <constraint>
+          <validator name="ip-protocol"/>
+        </constraint>
+      </properties>
+    </leafNode>
+    <node name="source">
+      <properties>
+        <help>NAT source parameters</help>
+      </properties>
+      <children>
+        #include <include/nat-address.xml.i>
+        #include <include/nat-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..af9dd1eff
--- /dev/null
+++ b/interface-definitions/nat.xml.in
@@ -0,0 +1,115 @@
+<?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>
+                      <constraint>
+                        <validator name="ipv4-prefix"/>
+                        <validator name="ipv4-address"/>
+                        <validator name="ipv4-range"/>
+                        <regex>(masquerade)</regex>
+                      </constraint>
+                    </properties>
+                  </leafNode>
+                  #include <include/nat-translation-port.xml.i>
+                </children>
+              </node>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>